今回やること
この記事では、手元のGitリポジトリをGitHubへ初めてpushします。
GitHubへpushする前に、公開してよい内容だけがcommitされているか確認します。
前提条件
- GitHubアカウントがある
- Gitがインストールされている
- SSHまたはHTTPSでGitHubへ接続できる
- 公開してよい学習用プロジェクトで試す
Step 1: ローカルリポジトリを確認する
git status
git log --oneline
まだcommitがない場合は、READMEを作ってcommitします。
echo "# My Project" > README.md
git add README.md
git commit -m "docs: add README"
Step 2: GitHubで空リポジトリを作る
GitHubの画面で新しいリポジトリを作成します。
このとき、ローカルにすでにREADMEがあるなら、GitHub側でREADMEを自動生成しない方が混乱しにくいです。
Step 3: リモートURLを追加する
GitHubで表示されたURLを使います。
SSHの場合です。
git remote add origin git@github.com:username/my-project.git
HTTPSの場合です。
git remote add origin https://github.com/username/my-project.git
追加できたか確認します。
git remote -v
Step 4: 初回pushする
git push -u origin main
-u は、今後 git push だけで同じリモートブランチへ送れるようにする設定です。
Step 5: GitHubで確認する
ブラウザでリポジトリを開き、READMEやファイルが表示されているか確認します。
Step 6: 公開前に見直す
push前に次を確認します。
git diff --staged
git log --oneline
秘密情報が含まれていないか確認します。
.env- APIキー
- パスワード
- 個人情報
- 本番URLや接続情報
一度pushした秘密情報は、ファイルを消すだけでは履歴に残る場合があります。
よくあるエラー
| エラー | よくある原因 | 確認すること |
|---|---|---|
remote origin already exists | すでにoriginがある | git remote -v を見る |
| pushできない | 認証設定の問題 | SSH/HTTPS設定を確認 |
src refspec main does not match | mainブランチやcommitがない | git branch と git log を確認 |
| GitHub側と履歴が違う | GitHubでREADMEを作った | pullまたは作り直しを検討 |
まとめ
GitHubへ初めてpushするときは、ローカルでcommitを作り、GitHubで空リポジトリを作り、git remote add origin で接続し、git push -u origin main で送ります。push前には、公開してよい内容だけが含まれているか必ず確認します。