.gitignore入門
バージョン管理から除外するファイルの設定
.gitignoreの書き方、よく使うパターン、既に追跡されたファイルの除外方法を解説します。
こんな人向けの記事です
- 不要なファイルをGitの追跡対象から除外したい人
- .gitignoreの書き方を学びたい人
Step 1.gitignoreとは
リポジトリのルートに.gitignoreファイルを作成し、Gitの追跡対象から除外するファイルやフォルダを指定します。
対象: ビルド成果物、依存パッケージ、環境設定ファイル、秘密情報などを除外します。
Step 2基本的な書き方
.gitignore
# コメント(#で始まる行)
# 特定のファイルを除外
secret.txt
# 特定の拡張子を除外
*.log
*.pyc
# 特定のフォルダを除外
node_modules/
__pycache__/
# フォルダ内の特定ファイル
logs/*.log
# 除外の例外(!で否定)
!important.logStep 3よく使うパターン
| パターン | 説明 |
|---|---|
| *.pyc | Pythonコンパイルファイル |
| __pycache__/ | Pythonキャッシュフォルダ |
| node_modules/ | Node.js依存パッケージ |
| .env | 環境変数ファイル |
| *.sqlite3 | SQLiteデータベース |
| .DS_Store | macOSシステムファイル |
| venv/ | Python仮想環境 |
参考: github/gitignoreに言語・フレームワーク別のテンプレートがあります。
Step 4既に追跡されたファイルの除外
.gitignoreに追加しても既に追跡されているファイルは除外されません。キャッシュから削除する必要があります。
ターミナル
# 追跡を解除(ファイルは残る)
git rm --cached ファイル名
# フォルダごと追跡を解除
git rm -r --cached フォルダ名/
# 変更をコミット
git commit -m "不要なファイルを追跡対象から除外"注意: --cachedを付けないとファイル自体が削除されます。必ず--cachedを付けてください。