ENH: Use pixi to install pre-commit, python for pre-commit#5032
Merged
hjmjohnson merged 2 commits intoInsightSoftwareConsortium:masterfrom Dec 11, 2024
Merged
ENH: Use pixi to install pre-commit, python for pre-commit#5032hjmjohnson merged 2 commits intoInsightSoftwareConsortium:masterfrom
hjmjohnson merged 2 commits intoInsightSoftwareConsortium:masterfrom
Conversation
thewtex
requested review from
N-Dekker,
blowekamp,
Copilot,
hjmjohnson and
jhlegarreta
github-actions
bot
added
type:Infrastructure
Member
Author
|
This also makes it easy to run the pre-commit hooks on demand on all files via: |
thewtex
force-pushed
the
pre-commit-pixi
branch
from
c05a571 to
7913f9f
Compare
Member
Author
|
Tested locally on Mac, Linux, and Windows. |
Member
|
Does that happen for you? If so, can you add these changes as a new commit? |
jhlegarreta
approved these changes
Dec 10, 2024
Member
jhlegarreta
left a comment
jhlegarreta
left a comment
There was a problem hiding this comment.
Have not tried, but I trust the change. Thanks @thewtex 💯.
On Windows, Python is not available by default. The SetupForDevelopment.sh script does not complete successfully in a default build on Windows. This uses pixi to install pre-commit, python for pre-commit, so the contribution experience works out-of-the-box for experienced and new contributors to ITK. This also improves the isolation and maintainability of pre-commit tooling. Everything needed for a commit is local to the ITK repository. We also get more reproducible versions of Python and pre-commit via pixi's configuration in pyproject.toml and pixi.lock. pixi is a self-contained, single-file, cross-platform Rust binary. A local version is installed to .git/hooks/pixi/bin/pixi. Pixi's python and pre-commit is installed to .pixi/. The installation of tools is: SetupForDevelopment.sh -> curl -> pixi -> python, pre-commit -> pre-commit's hook dependencies This also makes it easy to run the pre-commit hooks on demand on all files via: ``` pixi run pre-commit-run ```
Member
Author
@dzenanz thanks for testing. Yes -- I will add the commit to this branch. |
Generated via: pixi run pre-commit-run
thewtex
force-pushed
the
pre-commit-pixi
branch
from
7913f9f to
c201332
Compare
github-actions
bot
added
area:Core
dzenanz
approved these changes
Dec 10, 2024
Member
|
There seems to be some unforeseen side-effects of pre-commit hooks. Linting now fails for remote modules with message |
Member
|
Likely the action needs to be updated, may be something like this: https://github.com/InsightSoftwareConsortium/ITKClangFormatLinterAction/pull/3/files but with the correct version. |
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
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.
On Windows, Python is not available by default. The SetupForDevelopment.sh script does not complete successfully in a default build on Windows.
This uses pixi to install pre-commit, python for pre-commit, so the contribution experience works out-of-the-box for experienced and new contributors to ITK.
This also improves the isolation and maintainability of pre-commit tooling. Everything needed for a commit is local to the ITK repository. We also get more reproducible versions of Python and pre-commit via pixi's configuration in pyproject.toml and pixi.lock.
pixi is a self-contained, single-file, cross-platform Rust binary. A local version is installed to .git/hooks/pixi/bin/pixi. Pixi's python and pre-commit is installed to .pixi/.
The installation of tools is:
SetupForDevelopment.sh -> curl -> pixi -> python, pre-commit -> pre-commit's hook dependencies
This is to help get @N-Dekker going again and make the contribution process easier for new contributors.