Add rustfmt warning to CI #314
Merged
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
nepet
force-pushed
the
202311-add-format-warning
branch
2 times, most recently
from
3ce544b to
4996270
Compare
We are all human and forget to run formatters and checks. Let the CI help us to recognize and remedy our human failings! Signed-off-by: Peter Neuroth <[email protected]>
nepet
force-pushed
the
202311-add-format-warning
branch
from
4996270 to
5c556bd
Compare
|
ACK 5c556bd |
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.
This adds a job to the CI that checks every rust file that is changed by the PR for formatting. It will however not fail the CI (
continue-on-error: true) and still result in a green check mark.We could add
check-rustfmtas a prerequisite tocheck-selfif we want to run it locally and fail the CI if the formatter complains on changed filesAnother option would be to use something like https://github.com/marketplace/actions/continue-on-error-comment to write a comment into the PR about formatting issues. That would not be as aggressive as to fail the CI or to enforce local checks.
Tell me what you think about this!