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.

Sign up for GitHub

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

Jump to bottom

docs(pre-receive): fix filenames and python version #118

Merged
merged 1 commit into from
Oct 25, 2021
Merged

docs(pre-receive): fix filenames and python version #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ $ git push --push-option=breakglass

1. This pre-receive hook requires the host machine to have python>=3.8 and pip installed
1. Install ggshield from pip: `pip install ggshield`
1. Move `pre-receive-python.sample` to `.git/hooks/pre-receive` or to your provider's git hook directory
1. Move `pre-receive.sample` to `.git/hooks/pre-receive` or to your provider's git hook directory

- https://docs.gitlab.com/ee/administration/server_hooks.html

Expand All @@ -653,7 +653,7 @@ $ git push --push-option=breakglass
[**pre-receive-docker.sample**](doc/pre-receive-docker.sample)

1. This pre-receive hook requires the host machine to have docker installed.
1. Move `pre-receive.sample` to `.git/hooks/pre-receive`
1. Move `pre-receive-docker.sample` to `.git/hooks/pre-receive`
1. Do not forget to `chmod +x .git/hooks/pre-receive`
1. either set an environment variable machine wide `GITGUARDIAN_API_KEY` or set it in the `.git/hooks/pre-receive` as instructed in the sample file.

Expand Down
4 changes: 2 additions & 2 deletions doc/pre-receive.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/bin/sh
# ggshield as a pre-commit hook
# Prequirements:
# python >= 3.6, pip
# python >= 3.8, pip
# Installation instructions:
# Run: pip install ggshield
# Move `pre-receive-python.sample` to `.git/hooks/pre-receive`
# Move `pre-receive.sample` to `.git/hooks/pre-receive`
# Do not forget to `chmod +x .git/hooks/pre-receive`
# either set an environment variable machine wide `GITGUARDIAN_API_KEY`
# or uncomment and insert your key in the following line
Expand Down