Added gitsecrets hooks (#118)

techmatters · Nov 8, 2021 · 00bf9fa · 00bf9fa
1 parent a4d575d
commit 00bf9fa
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 0 deletions.
diff --git a/.githooks/commit-msg b/.githooks/commit-msg
@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+git secrets --commit_msg_hook -- "$@"
diff --git a/.githooks/pre-commit b/.githooks/pre-commit
@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+git secrets --pre_commit_hook -- "$@"
diff --git a/.githooks/prepare-commit-msg b/.githooks/prepare-commit-msg
@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+git secrets --prepare_commit_msg_hook -- "$@"
diff --git a/README.md b/README.md
@@ -3,6 +3,13 @@
 # serverless
 Repository for serverless functions living on [Twilio Functions](https://www.twilio.com/docs/runtime/functions).  Supports the [Aselo frontend](https://www.twilio.com/docs/flex/developer/plugins).  See [aselo.org](https://aselo.org/) or [contact Aselo](https://aselo.org/contact-us/) for more information.
 
+## git-secrets
+In order to prevent sensitive credentials to be leaked, please follow this instructions to setup `git-secrets`.
+- Install [git-secrets](https://github.com/awslabs/git-secrets) in your computer.
+- Go into the repo root folder.
+- Run `git secrets --register-aws`.
+- Run `git config --local core.hooksPath .githooks/`.
+
 ## Local development
 
 1- Clone repository:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#!/usr/bin/env bash
		git secrets --commit_msg_hook -- "$@"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#!/usr/bin/env bash
		git secrets --pre_commit_hook -- "$@"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#!/usr/bin/env bash
		git secrets --prepare_commit_msg_hook -- "$@"