8000 Manual counterparts of pre-commit commands · Issue #1637 · ukaea/PROCESS · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Manual counterparts of pre-commit commands #1637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
2 tasks
jonmaddock opened this issue Apr 25, 2022 · 4 comments · Fixed by #3665
Closed
2 tasks

Manual counterparts of pre-commit commands #1637

jonmaddock opened this issue Apr 25, 2022 · 4 comments · Fixed by #3665
Assignees
@clmould

Comments

@jonmaddock
Copy link
Contributor

In GitLab by @timothy-nunn on Apr 25, 2022, 12:26

  • add flake8 to requirements so it can be run manually?
  • add to pre-commit docs how each can be run manually, and why one might want to
@jonmaddock
Copy link
Contributor Author

On this topic, @ajpearcey and @cz1743 have both struggled to get pre-commit working using the docs alone. This need clarifying, especially with regards to real-world use i.e. when things go wrong. I think we need to make it clearer that pre-commit install needs to be run (in the docs, just not obvious). Maybe we need to start from "the quality stage has failed on the CI, what should I do?", as this is most people's experience.

@jonmaddock
Copy link
Contributor Author

Despite following the instructions in the docs to install pre-commit, I still managed to create and push a commit that failed both the black and flake8 jobs on the CI. I guess this is due to changes that were committed before I installed pre-commit, and that pre-commit was actually operating correctly on the changes I staged. I had to use pre-commit run --all-files to run everything manually and get the errors locally; as did Rhian and Alex. Can this get documented too?

There's a lot in the pre-commit section. Perhaps a "TLDR: but the quality job fails" section is a good idea, whereas the rest can be in a more detailed section.

@timothy-nunn timothy-nunn assigned clmould and unassigned timothy-nunn Jan 9, 2025
@timothy-nunn
Copy link
Contributor

@clmould you might determine that this issue was completed and be closed, I cant remember if I ever did

@clmould clmould mentioned this issue May 16, 2025
Merged
6 tasks
@clmould clmould linked a pull request May 16, 2025 that will close this issue
add tl;dr about failed quality jobs to pre-commit docs #3665
Merged
6 tasks
@clmould
Copy link
Collaborator
71FF clmould commented May 16, 2025

flake8 has been replaced by ruff. Added in the suggested tl;dr in #3665

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@clmould clmould

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add tl;dr about failed quality jobs to pre-commit docs ukaea/PROCESS
3 participants
@timothy-nunn @jonmaddock @clmould
0