Skip to content

Add more prominent message explaining what to do when static checks fail#31813

Merged
potiuk merged 1 commit intoapache:mainfrom
potiuk:improve-static-check-failure-message
Jun 9, 2023
Merged

Add more prominent message explaining what to do when static checks fail#31813
potiuk merged 1 commit intoapache:mainfrom
potiuk:improve-static-check-failure-message

Conversation

@potiuk
Copy link
Member

@potiuk potiuk commented Jun 9, 2023

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.


^ 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.rst or {issue_number}.significant.rst, in newsfragments.

@potiuk potiuk requested review from ashb and jedcunningham as code owners June 9, 2023 09:02
@potiuk potiuk requested a review from uranusjr June 9, 2023 09:02
@potiuk
Copy link
Member Author

potiuk commented Jun 9, 2023

This is how it will look like:

Screenshot 2023-06-09 at 10 55 40

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.
@potiuk potiuk merged commit b888012 into apache:main Jun 9, 2023
@potiuk potiuk deleted the improve-static-check-failure-message branch June 9, 2023 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants