サイトのコードをGitで残し、変更を確かめる

Gitで記録するファイルと除外するデータを分け、1ファイルの変更を確認して履歴に残す練習をします。

目次

Gitは、ファイルの変更を履歴として残し、以前の内容と比べる道具です。今回は、練習用サイトの説明ファイルを1つ作り、その内容を記録します。CMSに保存した記事や画像には、別途バックアップが必要です。

作業場所を確認する

Git公式の導入案内(別タブで開く)で自分のOS向けに準備し、ファイルを編集するアプリのVS Codeで練習用サイトのフォルダーを開きます。VS Code上部の「ターミナル」から「新しいターミナル」を開きます。Windowsではコマンドプロンプトを選び、Macでは通常のzshなどの入力画面を使います。以下のコマンドは一行ずつ入力してEnterを押します。入力画面の開き方

git --version

git version に続く番号が出れば、Gitを呼び出せています。「見つからない」などのエラーなら、導入が済んでいるか確認し、VS Codeを開き直します。

次に git status を実行します。すでにGitで管理しているフォルダーなら、表示された変更内容を確認し、そのサイトで決めている手順に従います。「not a git repository」なら、練習用サイトの中にいることを確認したうえで git init を実行します。パソコンの書類フォルダー全体で始めないようにします。

秘密情報を記録しない準備

.gitignore は、Gitで新しく追跡しないファイルを指定するものです。VS Codeでサイトのフォルダーを開き、package.json と同じ階層にある .gitignore を確認します。なければその名前でファイルを作ります。既存の内容を残し、実際の保存先に合わせて次のような対象を確認します。

node_modules/
dist/
.env
.env.*
data/
backups/

これは例です。node_modules/ は取り寄せた部品、dist/ は公開用に作ったファイル、.env や .env.* は接続情報などを書く設定ファイルを表します。data/ と backups/ は保存先の例なので、実際のデータベース(DB)や画像が別の場所にあれば、その場所も除外する必要があるか確認します。秘密値のない設定見本を残す場合は、ファイルの中身を確認して扱いを決めます。

.gitignore を書いても、すでに記録した秘密情報は履歴から消えません。 見つけたら共有を止め、鍵の失効・再発行と履歴の扱いを担当者へ相談します。

1ファイルだけを記録する

VS Codeで practice-notes.md という新しいファイルを作り、「週末ノートの制作メモ」と書いて保存します。同名のファイルがあれば、別名を選び、以下も置き換えます。

git status --short
git add practice-notes.md
git diff --staged

add は記録候補へ選ぶ操作、diff --staged は選んだ内容を確認する操作です。この記録候補を「ステージ」と呼びます。diff の表示に practice-notes.md と書いた文章が出るか確認します。長い表示を終了するときは q を押します。

変更をまとめて履歴へ記録する操作を「コミット」と呼びます。通常のコミットには、以前からステージに入っているほかの変更も含まれます。 別のファイルが表示されたら、ここではコミットせず、その変更をした担当者へ確認します。今回の練習のために、ほかの変更を消す必要はありません。コミット対象についての公式説明(別タブで開く)も参照できます。

今回の1ファイルだけが対象と確認できたら、次のコマンドで記録します。

git commit -m "制作メモを追加"

名前やメールアドレスを求められたら、Gitの初期設定(別タブで開く)に沿って自分の情報を設定します。コミットの情報は共有先にも渡るので、会社で使う表記を確認してください。設定できたら、先ほどのコミットのコマンドをもう一度実行します。

記録できたか確かめる

git log -1 --oneline
git status --short

log は履歴を見る操作です。直近の説明に「制作メモを追加」が出るか確認します。ほかの変更が残っていても、今回のために消す必要はありません。

作業を終えるときは、ファイルを保存してVS Codeを閉じてかまいません。次回は同じフォルダーを開き、git status で残っている変更を確かめてから続けます。

コミットは手元での記録です。GitLabなどへの送信や、本番の公開とは別の操作です。共有を始める前に、公開範囲と送信先を決めます。コード以外のDB・画像・秘密情報は専用のバックアップを用意します。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。