Fix ggshield install -m global
#978
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #978 +/- ##
==========================================
+ Coverage 91.49% 91.58% +0.08%
==========================================
Files 180 180
Lines 7597 7605 +8
==========================================
+ Hits 6951 6965 +14
+ Misses 646 640 -6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
agateau-gg
force-pushed
the
agateau/fix-install-global
branch
from
e77d22f to
917752f
Compare
salome-voltz
approved these changes
Oct 15, 2024
This wraps `platformdirs.user_data_dir()`. It's going to be used as the place to store our global git hook. Changing the place of the global git hook is required to make the code testable. It is also going to fix the fact that having the global git hooks created in $HOME/.git/hooks was weird: for 99% of our users, $HOME is not a git repository.
agateau-gg
force-pushed
the
agateau/fix-install-global
branch
from
917752f to
e397c7a
Compare
Problem: the fix from 1.32.1 to ignore the user git configuration when running git commands broke `ggshield install -m global` because this command modifies the global git config so it must not ignore the user git configuration. Solution: - Add a `ignore_git_config` optional argument to `git_shell.git()`, which defaults to True. Set it to False in calls from cmd.install. - Make `install_global()` install the git hooks in a sub-directory of the dir returned by `get_data_dir()`, this is required to be able to have tests which fail in the situation of 1.32.1. - Rework test_install to be able to reproduce the bug. Add more tests. chore: add changelog entry
agateau-gg
force-pushed
the
agateau/fix-install-global
branch
from
e397c7a to
039f554
Compare
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.
Context
The fix from 1.32.1 to ignore the user git configuration when running git commands broke
ggshield install -m globalbecause this command modifies the global git config so it must not ignore the user git configuration.This is #972.
What has been done
ignore_git_configoptional argument togit_shell.git(), which defaults to True. Set it to False in calls from cmd.install.install_global()install the git hooks in a sub-directory of the dir returned byget_data_dir(), this is required to be able to have tests which fail in the situation of 1.32.1.Best reviewed commit by commit.
Validation
Run
ggshield install -m global. It should not crash anymore.PR check list
skip-changeloglabel has been added to the PR.