git cryptをやめるときにハマったこと

はじめに

git cryptで暗号化していたファイルを平文に戻し、GitHubの画面上でレビューできる状態にするまでに時間がかかってしまったので、経緯を共有します

経緯

• git cryptという技術を使って、秘匿化したい環境変数ファイルを暗号化し管理していたが、別の管理方法に移行することにした
• 一部の環境変数は秘匿化の必要がなかったので、git cryptで暗号化するのをやめ、平文の環境変数ファイルとして残す方針にした

作業環境

• VSCode
• GitHub

行った作業

1. git crypt unlock を実行し、ローカル上の環境変数ファイルを復号化
   • この時点で、ローカル(VSCode)では平文の状態になっている
2. 環境変数ファイルを更新後、 git add / commit / push
   • 秘匿化の必要がない情報だけ残した
   • この時点で、githubのプルリクの差分画面には、バイナリファイル(=暗号化された状態)が表示されている
3. .gitattributes ファイルを git add / commit / push
   • .gitattributes ファイルでgit cryptの対象を管理している
   • 今回は環境変数ファイルをgit cryptの管理対象外にするため、記述を削除した

ここまで行って、プルリクの差分画面に平文の環境変数ファイルが表示されるかと思ったが、バイナリファイル(=暗号化された状態)のままだった

問題解決のためにやったこと

• 平文になったファイルをpushする
  • 作業3の後、VSCode上で環境変数ファイルに未保存のマークは出ていなかった
  • しかし、試しに ctrl + s してみると環境変数ファイルが変更扱いになった
  • → git add / commit / push

ただ、これでもGitHubのプルリクの差分画面はバイナリファイルのままだった

GitHub上での確認の仕方

• 結局、プルリクの差分画面で確認する方法は分からず
• プルリクの差分画面 > 対象ファイルの3点リーダー > View File で中身を見ることによって、平文になっていることが確認できた

最後に

• 始めるときのドキュメントは多いけど、やめるときのドキュメントは意外と少ないですね