Add CI infrastructure for pre-commit checks #62
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
This commit updates the sources files based on the automatic fixes applied using the "end-of-file-fixer" pre-commit hook introduced in the subsequent commit.
This commit updates the sources files based on the automatic fixes applied using the "mirrors-prettier" pre-commit hook introduced in the subsequent commit.
Introduce a noxfile with two sessions: 1. pre-commit: Runs pre-commit checks on all files except the ones generated by cookiecutter. 2. pre-commit-cookie: Runs pre-commit checks on a generated folder based on the cookiecutter template. The approach was adapted from the implementation at https://github.com/scientific-python/cookie/, originally contributed by @henryiii. Add corresponding GitHub Actions workflows in lint.yml to automate the pre-commit checks.
Add relevant exceptions: * F401: https://docs.astral.sh/ruff/rules/unused-import/ * F841: https://docs.astral.sh/ruff/rules/unused-variable/
This commit updates the sources files based on the automatic fixes applied using the "isort" ruff rule introduced in the subsequent commit.
jcfr
force-pushed
the
add-ci-infrastructure
branch
from
8a1401a
to
8f4ebde
Compare
This commit updates the sources files based on error reported after enabling the "flake8-unused-arguments" ruff rule introduced in the subsequent commit.
Since logic will likely be simplified in subsequent commit, annotations associated with HomeLogic.run have been omitted.
jcfr
force-pushed
the
add-ci-infrastructure
branch
from
e56d7c5
to
591a037
Compare
GitHub's security hardening guide recommends this mitigation method. https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions
|
Once this pull request is integrated, next enhancements to be integrated are the following: |
This commit updates the markdown files based on error reported after updating mirrors-prettier pre-commit hook to run for the "markdown" type in the subsequent commit.
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.
Introduce a noxfile1 with two sessions:
pre-commit: Runs pre-commit checks on all files except the ones generated by cookiecutter.pre-commit-cookie: Runs pre-commit checks on a generated folder based on the cookiecutter template.The approach was adapted from the implementation at https://github.com/scientific-python/cookie/, originally contributed by @henryiii.
For top-level and cookie-level projects:
lint.ymlGitHub Actions workflows to automate the pre-commit checks.commit-message.ymlGitHub workflows to enforce Slicer format for commit messages.Footnotes
https://nox.thea.codes/en/stable/ ↩