GitHubで作業履歴を残す基本｜commit・Issue・PR・CHANGELOGの使い分け
GitHubはファイルを置く場所だけでなく、なぜ変えたか、誰が確認したか、どこまで反映したかを残す場所として使えます。
このページでわかること
- commit、Issue、PR、CHANGELOGの役割を分けられる
- AI/Codex作業で残すべき証跡がわかる
- Secretsや個人情報を履歴に残さない線引きがわかる
まず確認すること
- commitは変更単位、Issueは目的、PRは差分確認として分ける
- CHANGELOGやrelease notesは利用者向けに必要な時だけ整理する
- AI/Codexに任せた範囲と人間確認を残す
- 本番反映や未確認事項を分けて書く
やってはいけないこと
- 履歴に実際のキー値や個人情報を書かない
- 非公開ログをそのまま公開しない
- 履歴があるだけで十分と決めつけない
安全寄りに進める手順
- 対象のrepo、branch、PR、Actions runを確認する。
- Secrets、APIキー、token、.env、個人情報が差分やログに出ていないか見る。
- 必要な場合は値を停止または再発行し、影響範囲を整理する。
- 変更は小さなbranchとPRに分け、CIとreviewで確認する。
CodexやAI作業時の注意
AIに作業を渡す時は、対象ファイル、触らないファイル、確認項目を明記します。認証情報や実際のキー値は本文、Issue、PR説明、ログ、レポートに残さないようにします。
一次情報で確認する領域
Actions、Secrets、PR、repository visibility、workflow permissionsは仕様が変わることがあります。実作業前にはGitHub Docsで最新の説明を確認してください。