はじめに
Gitを使ってプロジェクトを管理していると、バージョン管理から除外したいファイルが出てくることがあります。
例えば、機密情報が含まれるファイルや、環境依存の設定ファイルなどはリポジトリに含めたくありません。
自分はGPTのAPI-Keyを記載したファイルをGitHubにアップロードしてしまっていたことがあります、、、幸い不正利用などはありませんでしたが、とても危険なことです。
そうしたファイルをGitの管理下から除外するために活用するのが .gitignore です。本記事では、.gitignoreの基本的な使い方や、よくある除外パターンについて紹介します。
.gitignoreってなに？
.gitignore はGitが無視するファイルやディレクトリを指定するための設定ファイルです。
このファイルに記載されたパターンに一致するファイルやディレクトリは、Gitによって追跡されなくなります。これにより、プロジェクトの構成をクリーンに保ち、重要な情報の流出を防ぐことができます。
機密情報や環境ファイルをGit管理から外す理由
機密情報や環境設定ファイルをバージョン管理から外す理由は主にセキュリティの観点からです。
例えば、APIキーやデータベースの認証情報などが含まれたファイルをリポジトリに含めると、不特定多数の人がアクセスできる可能性があります。このような機密情報が漏れると、サービスのセキュリティが脅かされる危険性があるため、必ず .gitignore で除外しましょう。
その他Git管理下に置かないファイル
.gitignore には機密情報以外にも、次のようなファイルを指定することが一般的です。
- ビルド生成物： 例えば、コンパイル後に生成されるバイナリファイルやライブラリ。
- ソースコードから他の開発者やビルド環境で再生成できるし、リポジトリの肥大化の原因になりうる
- ログファイル： アプリケーションの実行時に作成されるログファイル。
- ログファイルに機密情報が含まれる可能性があり、リポジトリの肥大化の原因になりうる
- OS依存のファイル： Macの
.DS_StoreやWindowsのThumbs.dbなど。- 開発に必要な情報ではない
- IDEやエディタの設定ファイル： 特定の開発環境に依存する設定ファイル。
- 他の開発者が異なる設定やエディタを使っており、無用なコンフリクトが発生する可能性がある
.gitignoreの基本書き方とよく使うパターン
.gitignore はテキストファイルで、1行ごとに無視したいファイルやディレクトリを指定します。以下に、基本的なパターンをいくつか紹介します。
# 全てのlogファイルを除外
*.log
# 特定のディレクトリを除外
/secret/
# 全てのDS_Storeファイルを除外
*.DS_Store
# 環境変数ファイルを除外
.env
# バイナリファイルを除外
*.exe
これらのパターンを参考に、プロジェクトに応じた .gitignore を作成し、不要なファイルを管理から外すようにしましょう。
まとめ
.gitignore は、セキュリティ上重要なファイルや、不要なファイルをGitの管理下から除外するために非常に重要なツールです。適切に設定することで、プロジェクトをクリーンに保ちながら、セキュリティリスクを最小限に抑えることができます。これからGitを使う際には、必ずプロジェクトに応じた .gitignore を設定することを心がけましょう。
参考文献
- Git公式ドキュメント – https://git-scm.com/docs/gitignore
コメント