はじめに
gitignoreファイルってそういえばどうやって作るんだっけ?と少し困ったので、備忘録も兼ねて記事にします。
この記事の対象者
- Git初学者
- プログラミング初学者
開発環境
- OS:macOS Sequoia 15.7.1
- Git version:2.39.5 (Apple Git-154)
問題
- プログラミングの学習を進める際にGitでのプロジェクト管理にも慣れておこうと思い、GitHubで学習用のプロジェクトを管理した際に不要なビルドファイルまでもがGitで変更管理されてしまった
- そのため、チェックアウトの際にいちいち変更を破棄やスタッシュが必要な状態になった
- .gitignoreファイルで不要なファイルをGit管理から外そうとしたが、.gitignoreファイルの作り方が分からなく、調べる必要があった
解決方法
下記の手順で進めます。
- .gitignoreファイルを作成
- .gitignoreに無視したいファイルを書く
- .gitignoreを適用する
.gitignoreファイルを作成
まずはプロジェクト内に.gitignoreファイルを作成します。
ターミナルを開き、cdコマンドでプロジェクトのルートディレクトリに移動します。
cd yourProjectPath
移動したら、下記コマンドを入力します。
touch .gitignore
これでプロジェクトのルートディレクトリに.gitignoreファイルが作成されます。
.gitignoreに無視したいファイルを書く
何かしらのテキストエディタでファイルを開きます。
私はMacに最初から入ってるテキストエディットで開きました。
.gitignoreファイルの書き方は以下の通りです。
# 「#」をつけることでコメントが書けます
# 無視したいファイルを指定
# 特定の拡張子を指定
*.txt
# ファイル名を指定
sample.txt
# ディレクトリ全体を指定
sample/
# ルートディレクトリの特定ファイルを指定
/sample.txt
書き終わったら保存して閉じます。
すでにgit管理されているファイルやディレクトリを管理から除外したい場合、ターミナルに以下のコマンドを入力します。(コミットまで行うようにしましょう)
git rm --cached ファイル・ディレクトリ名
git commit -m "コミットコメント"
- git rm
Gitの管理から除外する - --catched
ローカルからは消さず、Gitの管理から外すだけにする - -m
コミットメッセージをコマンドで入力する
.gitignoreを適用する
.gitignoreを適用するには、gitにgitignoreを追加してコミットします。
ターミナルに以下のように入力します。
git add .gitignore
git commit -m "コミットコメント"
- git add
Gitの管理下にファイルやディレクトリを追加する
おわりに
まだまだ分からないことだらけで、記事内にも誤った情報を記載しているかもしれません。
お気づきの点などございましたら、コメントいただけますと幸いです。
参考サイト
Markdown記法 チートシート
gitignoreを設定して無視するファイルを指定しよう
Gitで不要なファイルを除外する:.gitignoreの完全ガイド