GitHubを見る前に
コード管理と秘密情報を分けて考える
GitHubはコード履歴や差分確認に向いています。APIキー、パスワード、DB情報などを置かないこともセットで確認しましょう。
まなぶちゃん
GitHubには何でも保存していいの？
GPTガイドくん
コード管理には便利ですが、秘密情報は入れません。差分を見るページと、入れてはいけないもののページを一緒に確認しましょう。
コードを見る差分を確認する秘密情報を避ける
Advanced
GitHub上級編
GitHub上級では、自動化とチーム運用を使いながら、人間レビューを残す設計を考えます。
このページは非公式の実践ガイドです。GitHubの画面や機能、料金、仕様は変わる可能性があります。最新情報が必要な場合は提供元情報を確認してください。
GitHub Actionsとは
GitHub Actionsは、ビルド、テスト、デプロイなどのワークフローを自動化する機能です。提供元ドキュメントでも、CI/CDのためにビルド、テスト、デプロイの流れを自動化できるものとして説明されています。
自動化は便利ですが、設定ミスの影響も大きくなります。最初は小さなテストや確認から始め、デプロイや本番反映は慎重に扱います。
チーム運用で見ること
保護ブランチ、レビュー必須ルール、CODEOWNERS、Issueテンプレート、Pull Requestテンプレート、Releaseやtag、Dependabotやセキュリティアラートを整理します。
外へ出せない値は通常ファイルに書かず、GitHubの保護された値として扱います。ただし、その値をAIにそのまま貼ることは避けます。
自動化と人間レビュー
自動テストや自動ビルドは確認漏れを減らす助けになりますが、判断をすべて置き換えるものではありません。AIレビューも自動化も、人間レビューの補助として扱います。
用語表
| 英語 | 日本語 | 意味 |
|---|---|---|
| Actions | アクション | ワークフロー自動化の仕組み |
| CI/CD | 継続的な確認と配信 | テストやデプロイを継続的に行う考え方 |
| protected branch | 保護ブランチ | 本体を守るための制限 |
| CODEOWNERS | コード所有者 | レビュー担当の目安を決めるファイル |
| release / tag | リリース / タグ | 区切りとなる版を残す仕組み |
悪い例 / 良い例
| 悪い例 | 良い例 |
|---|---|
| 自動化をいきなり本番反映に使う | 小さな確認から自動化する |
| 重要な値を通常ファイルに書く | 保護された値として扱い公開しない |
| AIレビューだけで完了扱いにする | 自動化と人間レビューを組み合わせる |
Actions導入前の確認例
GitHub Actionsを導入する前に確認する項目を整理してください。目的、実行タイミング、対象ブランチ、失敗時の扱い、保護する値、レビュー方法に分けてください。やってはいけないこと
- 外へ出せない情報や接続情報を通常ファイルに書く
- mainへ大きな変更を直接反映する
- AIレビューだけで完了扱いにする
- リポジトリや作業環境を混ぜる
- 変更後の確認を人間が行わない
確認チェックリスト
- Actionsの目的が明確
- 対象ブランチが明確
- 保護ブランチを検討した
- レビュー必須ルールを検討した
- 保護する値を通常ファイルに置いていない
- テンプレートを整えた
- 人間レビューを残す