Add pre-commit hooks to the repo #212
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
… description comment
Checks git commit messages with gitlint
kdreher
requested changes
Jul 25, 2023
README.md
Outdated
Comment on lines
71
to
99
| ## Install pre-commit hooks | ||
|
|
||
| In your SIMPA root directory run `pre-commit install` to set up the pre-commit hooks defined in `.pre-commit-config.yaml`. This will generate pre-commit hooks in `.git/hooks/` and run them for every commit. To run them manually before you commit, call `pre-commit run --all-files`. | ||
|
|
||
| <details> | ||
| <summary>Further information on pre-commit hooks</summary> | ||
|
|
||
| ### git config user email address checking | ||
| The `git-config-email-check` hook is by default commented out in `pre-commit-config.yaml`. If you want to get a warning when you are not using a specified git config user email address domain, then you might want to comment this hook in. Then you would have to place a file according to the given path, e.g. at `.git/hooks/check-email.sh` with the following content: | ||
|
|
||
| ```shell | ||
| #!/bin/bash | ||
| PWD=`pwd` | ||
| EMAIL=$(git config user.email) | ||
| if [[ $EMAIL == *"@yourdomain.com"* ]]; then | ||
| echo "[INFO] Verified email: $EMAIL" | ||
| else | ||
| echo "[ERROR] Invalid email: $EMAIL => Please configure the company email and retry." | ||
| echo "Steps:" | ||
| echo " cd $PWD" | ||
| echo ' git config user.email "<user>@yourdomain.com"' | ||
| echo "" | ||
| exit 1; | ||
| fi; | ||
| ``` | ||
|
|
||
| Change the domain in lines 4 and 10 according to your specific domain (e.g. corporate email domain) or even whole email address. | ||
| </details> | ||
|
|
There was a problem hiding this comment.
I think we should add this in the CONTRIBUTING.md file instead of the README.md
VERSION
Outdated
Comment on lines
0
to
1
| 0.8.11 No newline at end of file | ||
| 0.8.12 |
There was a problem hiding this comment.
Do we need this file anymore?
kdreher
approved these changes
Jul 26, 2023
kdreher
previously approved these changes
Jul 26, 2023
kdreher
approved these changes
Jul 26, 2023
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 PR installs the pre-commit hooks mentioned in
.pre-commit-config.yaml. It also adds new GitHub Actions.🔶 pre-commit hooks
pyproject.tomlunder[tool.autopep8]license_header.txtinto python files if there was none.gitlintfile.gitfolder. This hook is commented out by default but can be activated with instructions given in theREADME🚀 Misc:
Note that some commits were only done to check that the hooks work properly. so squash merging this PR might make sense.
Partly addresses issue #165 and solves #193
Steps to be done before merging:
To be tested during review:
pyproject.toml