GitHubを見る前に
コード管理と秘密情報を分けて考える
GitHubはコード履歴や差分確認に向いています。APIキー、パスワード、DB情報などを置かないこともセットで確認しましょう。
まなぶちゃん
GitHubには何でも保存していいの？
GPTガイドくん
コード管理には便利ですが、秘密情報は入れません。差分を見るページと、入れてはいけないもののページを一緒に確認しましょう。
コードを見る差分を確認する秘密情報を避ける
このページで分かること
中級編では、ひとり運用でもチーム運用でも使えるGitHubの確認フローを扱います。mainを直接触らず作業ブランチで進め、PRで差分を見せ、レビューしやすい単位に分け、必要に応じてActionsで自動確認します。
mainを直接触らない運用
mainは安定版として扱い、作業ごとにブランチを作ります。本文増強、CSS修正、リンク確認、sitemap更新のように目的を分けると、PRレビューが読みやすくなります。
Pull Requestレビューで見ること
- 変更目的が分かる
- 変更ファイルが多すぎない
- SEOタグが意図せず変わっていない
- 不要ファイルが混じっていない
- 秘密情報が混じっていない
- 戻す場合の手順が分かる
GitHub Actionsの使い方
GitHub Actionsは、リポジトリ内で開発ワークフローを自動化できる機能として案内されています。静的サイトならリンク確認、HTML確認、CSS確認、PHPサイトなら構文確認など、手動で忘れやすい確認を自動化する候補になります。
ただし、Actionsに秘密情報を直接書かないこと、外部サービスへ接続する処理は慎重に扱うことが重要です。
Codexに頼む例
このPull Requestの差分を確認してください。重大なバグ、SEOタグ変更、不要なファイル混入、秘密情報の混入、リンク切れの可能性を中心にレビューしてください。修正はせず、指摘だけ出してください。ChatGPTに相談する例
このPRの変更内容を、初心者にも分かるように要約してください。変更ファイル、目的、確認すべき点、戻す場合の注意に分けてください。中級確認チェックリスト
- main直変更を避けている
- 作業ブランチを使っている
- PRで差分を確認している
- IssueとPRを紐づけた
- Actionsで確認できる項目を検討した
- commit単位がレビューしやすい
- コンフリクト時は無理に進めない