ウェブサイト検索

.gitignore に含める 5 種類のファイル


プロジェクト内のすべてのファイルをバージョン管理する必要はありません。ソース リポジトリから除外する必要があるファイルの種類を見つけてください。

バージョン管理はコードベースの変更を追跡するための重要なツールですが、常にすべてのファイルを追跡したいとは限りません。

混乱を避け、機密情報を配布するリスクを軽減するには、.gitignore というファイルを使用できます。このファイルは、Git がインデックスを作成しないファイルとディレクトリを指定します。

どのファイルを .gitignore に含めるかを決定することは、特に開発が初めての場合は難しい場合があります。 Git ワークフローをよりスムーズにするために、どのファイルを .gitignore に追加する必要があるかを確認してください。

.gitignore ファイルの作成

.gitignore ファイルを有効にするには、プロジェクトで Git を初期化する必要があります。

ターミナルで以下のコマンドを実行して Git を初期化できます。

git init

このコマンドは、プロジェクトのバージョン管理に必要なすべてのファイルとディレクトリを含む非表示の「.git」サブディレクトリに、プロジェクトの新しい Git リポジトリを作成します。

このコマンドを実行するには、システムに Git がインストールされている必要があります。

次に、以下のコマンドを実行して .gitignore ファイルを作成します。

touch .gitignore

上記のコマンドを実行すると、現在のディレクトリに新しいファイル「.gitignore」が作成されます。ファイル名またはファイル パスを追加することで、Git からファイルを除外できます (ファイルが とは別のディレクトリにある場合) >.gitignore ファイル)。

Git はプロジェクト内のすべてのファイルを追跡する必要はなく、一部のファイルを追跡すると予期せぬ問題が発生する可能性があります。これらは、.gitignore に追加する必要があるファイルの一部です。

1. 設定ファイル

構成ファイルには、アプリケーションがその動作を定義およびカスタマイズするために使用する設定およびその他のパラメーターが保存されます。これらのファイルには、データベース接続文字列、API キー、および Git リポジトリに公開すべきではないその他の機密情報が保存されることがよくあります。

リポジトリに構成ファイルを含めると、それにアクセスできる人は誰でもその内容を表示できます。これには機密情報が含まれる可能性があり、セキュリティ侵害やその他の問題につながる可能性があります。

Git リポジトリから構成ファイルを除外するには、.gitignore ファイルに特定のファイル名またはフォルダ名を追加します。

たとえば、以下の行を .gitignore ファイルに追加して、.env< を無視できます。 ファイル。

.env

2. アーティファクトを構築する

ビルド アーティファクトは、プロジェクトのビルド時に生成されるコンパイル済みファイルまたは生成されたファイルです。これらのファイルは通常、「ターゲット」 ディレクトリまたは 「ビルド」 ディレクトリに存在します。

ビルド アーティファクトには、コンパイルされた Java クラス、JAR ファイル、WAR ファイル、バイナリ ファイル、配布パッケージ、レポート、ログ ファイル、およびビルド プロセス中に生成されるその他のファイルが含まれます。

ビルド アーティファクトは非常に大きくなる可能性があるため、一般に Git リポジトリから除外することをお勧めします。また、ソース ファイルよりも移植性が低く、特定の環境にのみ関連する可能性があります。これらをリポジトリに含めると、リポジトリのサイズが肥大化し、クローンの作成や操作が遅くなる可能性があります。

Git リポジトリからビルド アーティファクトを除外するには、"target/" または "build/" ディレクトリを .gitignore ファイルに追加します。

例えば:

# .gitignore
target/
build/

3. 統合開発環境ファイル

統合開発環境 (IDE) ファイルは、プロジェクトを作成するか開くときに IDE によって生成される構成ファイル、プロジェクト メタデータ、およびその他のファイルです。これらのファイルは各 IDE に固有です。 IDE はこれらのファイルを使用してプロジェクト設定を構成します。

これらのファイルはアプリケーションの構築や実行には不要であり、共有 Git リポジトリにコミットすると問題が発生する可能性があります。たとえば、チーム内のさまざまなメンバーが異なる IDE またはバージョンを使用している可能性があり、IDE 固有のファイルをコミットするとマージ競合が発生し、プロジェクトでの共同作業が困難になる可能性があります。

これらのファイルは IDE 固有であるため、.gitignore に含めるファイルは ファイルは IDE によって異なります。ここでは、いくつかの人気のある IDE に対する GitHub の .gitignore 推奨事項を示します。選択した IDE を検索し、アウトライン ファイルを .gitignore に追加できます。 ファイル。

4. 依存関係ファイルとパッケージ ファイル

依存関係ファイルとパッケージ ファイルは、アプリケーションで使用される依存関係とパッケージに関する情報を含むファイルです。 Node Package Manager (npm) などのさまざまなビルド ツールによって、これらのファイルが生成されます。

たとえば、npm を使用して JavaScript プロジェクトの依存関係を管理すると、プロジェクトのルート ディレクトリに「node_modules」フォルダーが作成されます。このディレクトリには、プロジェクトにインストールされているすべての依存関係が含まれています。

このディレクトリは、特にプロジェクトに多くの依存関係がある場合、または一部の依存関係のファイル サイズが大きい場合、非常に大きくなる可能性があります。 Git リポジトリから「node_modules」フォルダを除外すると、リポジトリをクリーンな状態に保ち、サイズを減らすことができます。

node_modules」ディレクトリを Git リポジトリに追加しないようにするには、その名前を .gitignore ファイルに追加します。

#.gitignore
node_modules/

5. オペレーティング システム ファイル

オペレーティング システムやその他のシステム ツールは、通常の使用によってファイルを生成する場合があります。これらには、ログ ファイル、一時ファイル、システム構成ファイルが含まれる場合があります。例としては、Windows の Thumbs.db ファイルと、macOS の同等の .DS_Store ファイルがあります。

オペレーティング システム ファイルはローカル環境に固有であり、コンピューターやオペレーティング システムによって異なる可能性があるため、一般に、Git リポジトリからオペレーティング システム ファイルを除外することをお勧めします。

GitHub は、Windows、macOS、Linux 向けに .gitignore ガイドラインを推奨しています。

バージョン管理の重要性

バージョン管理を使用すると、ワークフローが大幅に改善され、コードベースでの作業中に発生する可能性のあるエラーや競合が軽減されます。バージョン管理を使用すると、コードの変更を簡単に追跡し、レビューし、チーム メンバーとシームレスに共同作業できます。

ただし、構成ファイル、IDE ファイル、OS ファイルなどの特定のファイルは常に除外する必要があります。これにより、リポジトリのサイズが抑えられ、機密情報が漏洩することがなくなります。

関連記事: