Skip to content
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.

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

GIT: added badges for documentation, tests and pre-commit #15

Merged
merged 1 commit into from
Feb 3, 2025

Conversation

rpartzsch
Copy link
Collaborator

Refactored standard tests into pre-commit and pytests.
Also added Github badges for the three actions (tests, pre-commit and documentation).

@rpartzsch rpartzsch added documentation Improvements or additions to documentation enhancement New feature or request tests Related to tests labels Jan 29, 2025
@rpartzsch rpartzsch requested a review from cbespin January 29, 2025 13:05
@cbespin
Copy link
Collaborator

cbespin commented Jan 31, 2025

Does the pre-commit workflow just run the hook again? Or check if the hook was run (which would be handled by git locally, I assume)? I am not sure I understand the reason but I have also never used it

@rpartzsch
Copy link
Collaborator Author

The way I understand it is, pre-commit runs the hooks defined in .pre-commit-config.yaml again. Changes are not commited, but error codes are raised if changes would be needed. So if black fails in development then the pre-commit badge would also show failing.

@rpartzsch rpartzsch merged commit 8f39a1f into development Feb 3, 2025
5 checks passed
@rpartzsch rpartzsch deleted the git_badges branch February 3, 2025 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request tests Related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants