Add more prominent message explaining what to do when static checks fail#31813
Merged
potiuk merged 1 commit intoapache:mainfrom Jun 9, 2023
Merged
Conversation
Member
Author
Pre-commit prints a useful message when static check changes ``` Update ER diagram..................................................................Passed pre-commit hook(s) made changes. If you are seeing this message in CI, reproduce locally with: `pre-commit run --all-files`. To run `pre-commit` as part of git workflow, use `pre-commit install`. All changes made by hooks: ``` But it is not highglighted in any way in the CI output and it might be missed when users are not familiar with pre-commit. We repeat the message and add more detailed instructions what to do (Including helpful `breeze static-checks --only-my-changes` commamnd that helps to run static checks faster. We do it also in the way that will be more prominently displayed at the end of the output and highlighted. We can point the user to follow those instructions if they ask rather than explain them to look at CONTRIBUTING guide.
d090b8d to
dd9757b
Compare
This was referenced Jun 9, 2023
Merged
pierrejeambrun
approved these changes
Jun 9, 2023
eladkal
approved these changes
Jun 9, 2023
This file contains hidden or 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
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.

Pre-commit prints a useful message when static check changes
But it is not highglighted in any way in the CI output and it might be missed when users are not familiar with pre-commit.
We repeat the message and add more detailed instructions what to do (Including helpful
breeze static-checks --only-my-changescommamnd that helps to run static checks faster. We do it also in the way that will be more prominently displayed at the end of the output and highlighted. We can point the user to follow those instructions if they ask rather than explain them to look at CONTRIBUTING guide.^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.