configure pre-commit for project #346
Merged
Conversation
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
|
Not really sure why the CI is failing on generation as none of that code has been touched here. |
|
The CI failures were caused as |
|
The new failures should be resolved via #345. |
This change moves black and doc8 checking into pre-commit hooks. This also simplifies the ci code quality workflow. In addition, doc8 configuration is now moved to `pyproject.toml`.
When `--exclude` is used, the default exclude list is overwritten. The expected option is `--extend-exclude`. However, since the generated files are already ignored, these flags can be safely skipped,
|
@Gobot1234 would be great to get this one in too; should speed up CI by ~2.5 minutes based on the current active runs. Particularly since the cache key is the lock file too. |
Gobot1234
approved these changes
Mar 3, 2022
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 change moves black and doc8 checking into pre-commit hooks. This also simplifies the ci code quality workflow. In addition, doc8 configuration is now moved to
pyproject.toml.This is more a proposal to make development experience a bit easier and standardised. It helps to not have to remember to execute all the required checks before pushing up code. Additionally, having a standard config mechanism helps the CI job to be simpler. This can potentially be outsourced to pre-commit.ci as well to keep the hooks up-to-date.
peo: fix black task to include gitignore
When
--excludeis used, the default exclude list is overwritten. The expected option is--extend-exclude. However, since the generated files are already ignored, these flags can be safely skipped,