Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

project+ci: Succeed ruff format check but keep a notice annotation #770

Merged
merged 2 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ jobs:
needs: find-changed-files
if: ${{ needs.find-changed-files.outputs.files != '[]' }}
runs-on: ubuntu-latest
# Allow the workflow run to pass when this job fails
continue-on-error: true
strategy:
fail-fast: false
matrix:
Expand All @@ -55,12 +53,17 @@ jobs:
- uses: actions/checkout@v4

- name: Run ruff format check for ${{ matrix.files.path }}
id: format-check
uses: astral-sh/ruff-action@v1
# Allow the job run to pass when this step fails
continue-on-error: true
with:
args: "format --check --diff"
src: "${{ matrix.files.path }}"
version: 0.8.1

- name: Annotate unformatted file
if: ${{ failure() }}
if: ${{ steps.format-check.outcome }} == 'failure'
run: |
echo "::warning file=${{ matrix.files.path }},title=File format check failed::Run 'ruff format ${{ matrix.files.path }}'"
JOB_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
echo "::notice file=${{ matrix.files.path }},title=Unformatted file::Consider running 'ruff format ${{ matrix.files.path }}'%0ASee $JOB_URL for more details"
3 changes: 0 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,6 @@ extend-select = [
"UP", # pyupgrade
"W", # pycodestyle warnings
]
ignore = [
"UP027", # deprecated pyupgrade rule
]

[tool.ruff.format]
quote-style = "preserve"
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ deps =
types-PyYAML
flake8
mypy
ruff
ruff==0.8.1
setenv =
# For instance: ./.tox/py3/tmp/
TOXTEMPDIR={envtmpdir}
Expand Down
Loading