.gitignoreの重要性
Git で管理すべきでないファイルの考え方と、.gitignore の書き方を整理します。
1. Gitで管理すべきでないファイル
Gitはデフォルトではすべてのファイルを管理対象として扱います。しかし、プロジェクトの中には、Gitで管理すべきでないファイルが数多く存在します。
特に注意が必要なのが機密情報を含むファイルです。AWSのアクセスキーやデータベースのパスワード、APIキーなどを記載したファイルをうっかりコミットしてしまうと、その内容がGitHub上で誰でも閲覧できる状態になってしまいます。さらに、Gitはすべての変更を履歴として記録しているため、一度コミットされた機密情報は、後からファイルを削除しても履歴の中に残り続けます。過去に、企業のAWSアクセスキーがGitHubに公開されてしまい、不正利用によって高額な請求が発生した事例も報告されています。
また、venv/のようなPythonの仮想環境フォルダは数千ファイルに及ぶことがあり、これをコミットするとリポジトリのサイズが膨大になります。__pycache__/や.DS_Storeのような自動生成ファイルも、管理対象に含めると不要な変更差分が発生し、レビューやコミット履歴の見通しが悪くなります。
こうした問題を防ぐために用意されている仕組みが、次に紹介する.gitignoreです。
2. .gitignoreとは
.gitignoreは、Gitの管理対象から除外するファイルやフォルダを指定するための設定ファイルです。リポジトリのルートディレクトリに.gitignoreという名前で作成し、除外したいファイルやフォルダのパターンを1行ずつ記述します。.gitignoreに記載されたファイルは、git addを実行しても自動的にステージングの対象外となるため、うっかりコミットしてしまう事故を防ぐことができます。
3. .gitignoreの書き方
.gitignoreの基本的な書き方を紹介します。ファイル名をそのまま記述するとそのファイルが除外され、フォルダ名の末尾に/を付けるとそのフォルダ全体が除外されます。*はワイルドカードとして任意の文字列にマッチし、#で始まる行はコメントとして扱われます。
以下は、Pythonプロジェクトにおける.gitignoreの例です。
# 環境変数・機密情報
.env
credentials.json
*.key
*.pem
# Python
__pycache__/
*.pyc
venv/
# IDE
.vscode/
.idea/
# OS
.DS_Store
Thumbs.db
この例では、.envやcredentials.jsonといった機密情報を含むファイル、__pycache__/やvenv/といったPythonの自動生成ファイルや依存パッケージ、.vscode/などのIDE設定ファイル、.DS_StoreのようなOS固有のファイルを除外しています。
以下は、よく.gitignoreに指定すべきファイル・フォルダの一覧です。
| ファイル・フォルダ | 理由 |
|---|---|
.env |
環境変数(パスワードやAPIキー)を含む |
credentials.json |
認証情報を含む |
*.key、*.pem |
秘密鍵ファイル |
__pycache__/ |
Pythonが自動生成するキャッシュファイル |
venv/ |
Python仮想環境(サイズが大きく再現可能) |
.vscode/、.idea/ |
IDE固有の設定ファイル |
.DS_Store |
macOSが自動生成するファイル |
| 💡 ポイント |
|---|
.gitignoreはプロジェクトの初期段階で設定することが重要です。一度コミットしてしまったファイルは、後から.gitignoreに追加しても履歴から自動的に削除されることはありません。プロジェクトを始める際は、使用する言語やフレームワークに合わせた.gitignoreのテンプレートがGitHub上で公開されているため、それを活用するのがおすすめです。 |