Laravel .gitignore テンプレート解説

Laravel.gitignore は Composer と npm で依存関係をインストールする Laravel アプリケーション向けである。Laravel プロジェクトに標準で入っている .gitignore と同様のルールに、Homestead・Vagrant のような開発環境のファイルが加わっている。

最も重要なのは .env である。Laravel は DB パスワード、APP_KEY、メール・決済の API キーをすべて .env から読み込むため、このファイルがコミットされるとアプリケーションの秘密がすべて露出する。

ルール別の解説

パターン	何を、なぜ無視するか
/vendor/node_modules/	依存関係composer install と npm install で作り直されるフォルダーである。composer.lock と package-lock.json はコミットし、同じバージョンがインストールされるようにする。
.env.env.backup.env.production	環境ファイルアプリケーションの秘密と環境ごとの設定である。変数の一覧は .env.example で共有し、このテンプレートはそのファイルを無視しない。
public/storagepublic_html/storagestorage/*.key	ストレージリンク・キーphp artisan storage:link が作るシンボリックリンクと、Passport の OAuth 秘密鍵(oauth-private.key)である。リンクはサーバーごとに作り直し、キーは秘密である。
/public/buildpublic/hotpublic_html/hotnpm-debug.logyarn-error.log	フロントエンドのビルドVite が作ったビルド結果と、開発サーバーが起動していることを知らせる hot ファイルである。hot ファイルがコミットされると、本番サーバーが存在しない開発サーバーからアセットを読み込もうとする。
.phpunit.result.cache/.phpunit.cache	テストキャッシュPHPUnit が失敗したテストの順序などを記録するキャッシュである。
Homestead.yamlHomestead.json/.vagrant.phpactor.json/storage/pail	開発環境・ツール個人の Homestead 設定、Vagrant の状態、Phpactor の設定、Laravel Pail のログファイルである。
auth.json	Composer の認証非公開パッケージリポジトリのトークンやパスワードが保存される Composer の認証ファイルである。
bootstrap/compiled.phpapp/storage/	レガシーパスLaravel 4 時代のコンパイルファイルとストレージのパスである。最新バージョンでは生成されない。

実務での注意点

• .env.example には実際の値の代わりにプレースホルダーを置いてコミットする。
• storage/ 配下の app、framework、logs フォルダーには Laravel が標準で置いたサブ .gitignore があるので削除しない。
• .env が履歴に残っている場合は、php artisan key:generate で APP_KEY を変更し、DB・API のパスワードも差し替える。

元のテンプレート

/vendor/node_modules/npm-debug.logyarn-error.log# Laravel 4 specificbootstrap/compiled.phpapp/storage/# Laravel 5 & Lumen specificpublic/storagepublic/hot# Laravel 5 & Lumen specific with changed public pathpublic_html/storagepublic_html/hotstorage/*.key.envHomestead.yamlHomestead.json/.vagrant.phpunit.result.cache/.phpunit.cache/public/build/storage/pail.env.backup.env.production.phpactor.jsonauth.json

一緒に使うテンプレート

ほかのテンプレートの解説