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

pre-commit: installed git hook should have full path to binary #77638

Merged
merged 1 commit into from Feb 1, 2020

Conversation

kalbasit
Copy link
Member

Motivation for this change

pre-commit currently install impure Git hooks that look for the pre-commit binary in PATH. If the user has pre-commit loaded via a nix-shell instead of having it installed then GUI editors, such as Intellij, won't be able to use Git commit because the hook fails trying to look for the pre-commit binary in PATH.

This patch updates the hook template to use the hardcoded path to the pre-commit binary if it was found, fallback to using the one from PATH.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

cc @Charg @fmartinho

@kalbasit
Copy link
Member Author

@GrahamcOfBorg build pre-commit

pre-commit currently install impure Git hooks that look for the
`pre-commit` binary in PATH. If the user has `pre-commit` loaded via a
nix-shell instead of having it installed then GUI editors, such as
Intellij, won't be able to use Git commit because the hook fails trying
to look for the `pre-commit` binary in PATH.

This patch updates the hook template to use the hardcoded path to the
`pre-commit` binary if it was found, fallback to using the one from
PATH.
@ofborg ofborg bot requested a review from borisbabic January 14, 2020 06:58
@kalbasit kalbasit changed the title pre-commit: installed git hook should have full path to pre-commit pre-commit: installed git hook should have full path to binary Feb 1, 2020
@kalbasit kalbasit merged commit 1882d20 into NixOS:master Feb 1, 2020
@kalbasit kalbasit deleted the nixpkgs_precommit-pure branch February 1, 2020 18:05
anna328p pushed a commit to anna328p/nixpkgs that referenced this pull request Feb 2, 2020
…#77638)

pre-commit currently install impure Git hooks that look for the
`pre-commit` binary in PATH. If the user has `pre-commit` loaded via a
nix-shell instead of having it installed then GUI editors, such as
Intellij, won't be able to use Git commit because the hook fails trying
to look for the `pre-commit` binary in PATH.

This patch updates the hook template to use the hardcoded path to the
`pre-commit` binary if it was found, fallback to using the one from
PATH.
jpgu-epam pushed a commit to jpgu-epam/nixpkgs that referenced this pull request Feb 4, 2020
…#77638)

pre-commit currently install impure Git hooks that look for the
`pre-commit` binary in PATH. If the user has `pre-commit` loaded via a
nix-shell instead of having it installed then GUI editors, such as
Intellij, won't be able to use Git commit because the hook fails trying
to look for the `pre-commit` binary in PATH.

This patch updates the hook template to use the hardcoded path to the
`pre-commit` binary if it was found, fallback to using the one from
PATH.
@edolstra
Copy link
Member

This is wrong because Git hooks are not GC roots. So any store path referenced from hooks can be garbage-collected at any time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants