From 361004d55f5b8300aa828456a046e1e54200c648 Mon Sep 17 00:00:00 2001 From: Pieter De Gendt Date: Mon, 2 Dec 2024 12:04:57 +0100 Subject: [PATCH] ci: Change format warning to notice, and succeed the job if step fails Github only has 2 states for the result of a job, either success or error. A warning state would be nice but isn't available. We still add a notice to changed files to suggest contributors to format. Signed-off-by: Pieter De Gendt --- .github/workflows/format.yml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index 3598b072..62cd1194 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -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: @@ -55,13 +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"