git-secretsの設定方法

git-secrets の設定方法

サーバーのアクセスキーの情報やシークレット情報を使って開発することはあると思いますが、どれだけ気をつけていても git に誤ってコミットしてしまう可能性があります。

そのときに予防線として設定しておくのが、git-secrets です。機械的に秘密情報を git にコミットしようとすると弾いてくれる便利なやつです。

とりあえず必ずやっておくこと（ Mac 編）

まずは、Mac の設定方法を記します。

以下のコマンドを設定すると、PC 上にある全 git でバージョン管理されている対象に対して、AWS / GCP の保護を行う git-secrets の機能が適応されます。

# git secretsのinstall
$ brew install git-secrets

# 端末全体のgitでバージョン管理されているリポジトリの保護
$ git secrets --install ~/.git-templates/git-secrets
$ git config --global init.templatedir '~/.git-templates/git-secrets'

# AWSの保護
$ git secrets --register-aws --global

# GCPの保護
$ git secrets --add 'private_key' --global
$ git secrets --add 'private_key_id' --global

そのほかの細かい機能については、別途記事などを参考にしてください。

とりあえず必ずやっておくこと（ Windows 編）

こちらでは、Windows マシンへの導入の説明をします。

PowerShell からインストールします。

PowerShell を管理者権限で起動させて、以下のようにクローンします。


PS: cd 任意のフォルダ
PS: git clone https://github.com/awslabs/git-secrets.git

クローン後に、公式の手順通りに PowerShell スクリプトを実行します。


PS: cd git-secrets
PS: git-secrets> ./install.ps1
Checking to see if installation directory already exists...
Creating installation directory.
Copying files.
Checking if directory already exists in Path...
Adding to path.
Adding to user session.
Done.

PowerShell を初期設定のまま使用していると、実行ポリシーの影響でスクリプトを実行できません。

その場合、こちらを参考に、実行ポリシーを変更して、PowerShell スクリプトを実行してください。

そのほかの細かい機能については、別途記事などを参考にしてください。

参考

備考

Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。