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

Adds gitguardian pre-commit hook #194

Closed
wants to merge 1 commit into from
Closed

Conversation

tnodell
Copy link
Contributor

@tnodell tnodell commented Nov 22, 2023

https://app.clickup.com/t/2704425/ID-5738

This installs a pre-commit step to prevent sensitive data from being committed.

Once this is merged, you will have to:

  1. Install ggShield

brew install gitguardian/tap/ggshield

  1. Install pre-commit

brew install pre-commit

  1. install dependencies
  2. pre-commit install at the root of the project
  3. ggshield auth login to Connect your Github account to GitGuardian. On your next commit, you will be asked to authenticate with GitGuardian.

Now a precommit hook will run every time a commit is made.

https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit

2023-11-23_10-46-22.mp4

@dylanlt dylanlt self-requested a review November 29, 2023 02:50
Copy link
Contributor

@dylanlt dylanlt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am unable to run "pnpm i" without errors, so I have only done the first steps. At this point I can still commit to my local branch.

@siowhoi
Copy link
Contributor

siowhoi commented Nov 29, 2023

Need to run pre-commit install

Copy link
Contributor

@steve-keep steve-keep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm uncomfortable using GitGuardian here as anyone looking to contribute to the repo would need to connect their Github account to GitGuardian.

Instead, we should look to implement https://github.com/gitleaks/gitleaks as it is open-source and widely adopted.

@tnodell
Copy link
Contributor Author

tnodell commented Dec 6, 2023

Closing in favor of
#202

@tnodell tnodell closed this Dec 6, 2023
@thekevinbrown thekevinbrown deleted the feat/pre-commit-hook branch June 6, 2024 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants