project+ci: Succeed ruff format check but keep a notice annotation #770
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Prevent ruff issues being reported by updates of the tool itself. UP027 has been removed in version 0.8.0, remove it from the ignore list. Signed-off-by: Pieter De Gendt <[email protected]>
marc-hb
reviewed
Dec 2, 2024
.github/workflows/format.yml
Outdated
| run: | | ||
| echo "::warning file=${{ matrix.files.path }},title=File format check failed::Run 'ruff format ${{ matrix.files.path }}'" | ||
| echo "::notice file=${{ matrix.files.path }},title=Unformatted file::Consider running 'ruff format ${{ matrix.files.path }}'" |
There was a problem hiding this comment.
Please tell the user that the formatted code can be found in the check logs.
(technically: the diff but no need to mention that here)
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 <[email protected]>
marc-hb
approved these changes
Dec 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prevent ruff issues being reported by updates of the tool itself.
UP027 has been removed in version 0.8.0, remove it from the ignore list.
For CI move the
continue-on-errorto the format step instead of the job. This should set the job status to green, we only print a notice annotation.See #771 how the result looks.