HUGOに適した.gitignoreの設定

最終更新日:2022-06-15 公開日:2022-05-27
約1600字約7分で読めます
カテゴリー:HUGO

.gitignoreの基本

それぞれ、掘り下げていきます！

.gitignoreのは拡張子だけのファイルなので、ソフトや環境によっては作成できないことがあります。

vscodeやatomなどの総合エディターでファイルを作成するのがオススメです。

vscodeで作成する場合、新規ファイル作成で空のファイルを作って、.gitignoreとファイル名をつければ完了です。

.gitignoreの書き方を説明します。
基本的に管理対象から外したいものとコメントを書きます。

コメントは#、管理対象から外すものはそのまま記述するのが基本です。

#gomi1-3を対象外にする
gomi1
gomi2
gomi3

これで、gomi1、gomi2、gomi3は管理対象からはずれます。

何パターンか実際に使う書き方を紹介します。

#gomiフォルダの中を全部無視
gomi/

#useフォルダのgomi4を無視する
use/gomi4

# PNGを無視する
.png

# ロゴの.pngは残す
!/assets/image/logo.png

それぞれ、掘り下げていきます！

私はHUGOの管理は、VScodeとObsidianの2つを使っています。
htmlやcssなどを編集するときはVScodeで、記事の執筆はObsidianをと分けているのです。

なので、プロジェクトのルートには.vscodeがあり、contentには.obsidianがあります。

これら2つのファイルはHUGOのデプロイには関係無いので、.gitignoreの対象にしました。

/resources/_genとかを対象にするケースもあるでしょう。

作成した.gitignoreファイルの設置ディレクトリは、.gitフォルダと同じディレクトリに設置しましょう。

最初から.gitignoreを正しく設定していれば良いのですがあとから気づく追加する場合もあるでしょう。
私はそうでした。

あとから.gitignoreを作成した場合、.gitignoreファイルで指定した内容もリポジトリに残ったままになります。

少し作業が必要ですが、コマンドを少し叩くだけなんで3分もあれば大丈夫です。

まず、作成した.gitignoreをリポジトリに追加しましょう。
コマンドは以下です。

git add .gitignore
git commit -m ".gitignore追加"
git push

これで、リポジトリに.gitignoreが追加されました。

つぎは.gitignoreファイルの内容を反映させましょう。
コマンドは以下です。

git rm -r --cached .
git add .
git commit -am ".gitignoreファイルの除去"
git push

これで.gitignoreの内容が反映されました。

補足すると、git rmで不要なファイルごと削除して、git rm --cachedにすることで、ファイルをワークツリーに残してインデックスからの削除だけを実行してくれます。

管理対象から外すファイルを除去して、それ以外の全ファイルをaddとcommitをして、最後にPushして完了という感じです。

HUGOで.gitignoreを設定する場合は、プロジェクトにルートに.gitignoreを設置して、.gitignoreの内容を反映させるアクションをすれば大丈夫です。

カテゴリー:HUGO