GitHub の Issues と Actions
GitHub は Git のリポジトリを置く場所であると同時に、チームで開発を進めるための道具 がそろったサービスです。ここではプルリクエスト以外によく使う機能、特に Issues と Actions を紹介します。
画面の配置や細かい仕様は更新されることがあります。最新の情報は GitHub の公式ドキュメントで確認してください。
Git と GitHub の違い(おさらい)
| Git | GitHub | |
|---|---|---|
| 正体 | バージョン管理ソフト(手元で動く) | Git リポジトリをホストする Web サービス |
| できること | コミット、ブランチ、マージなど履歴の管理 | 共有、PR、Issues、Actions、権限管理など |
| 代わりになるもの | — | GitLab、Bitbucket、Gitea など |
このページの Issues や Actions は GitHub の機能 で、Git コマンドには存在しません。GitLab などにも似た機能がありますが、名前や書き方が違います。
Issues ― やることと問題を管理する
Issue は「このリポジトリについての話題 1 件」です。バグ報告、機能の提案、質問、作業のメモなどを 1 件ずつ登録し、コメントで議論します。
Issue を書くときのポイント
バグ報告なら、読んだ人が 自分の手元で再現できる ように書きます。
タイトル: ログイン画面で空欄のまま送信するとエラー画面になる
## 再現手順
1. /login を開く
2. 何も入力せずに「ログイン」を押す
## 期待する動作
「メールアドレスを入力してください」と表示される
## 実際の動作
500 エラーの画面が表示される
## 環境
Chrome 最新版 / macOS機能の提案なら「何に困っていて」「どうなるとうれしいか」を書くと議論が進みます。
Issue を整理する仕組み
| 機能 | 用途 |
|---|---|
| Labels(ラベル) | bug、enhancement、good first issue などの分類 |
| Assignees(担当者) | 誰が対応するか |
| Milestones | 「v1.0 までに直すもの」のように期限やリリースでまとめる |
| Projects | Issue や PR をカンバン(ToDo / 作業中 / 完了)や表で管理するボード |
| Issue テンプレート | 新規作成時に記入欄をあらかじめ用意しておく(.github/ISSUE_TEMPLATE/ に置く) |
Issue と PR・コミットをつなぐ
本文やコメントに #番号 と書くと、その Issue や PR へのリンクになります。
さらに PR の説明文に次のようなキーワードを書いておくと、PR がデフォルトブランチにマージされたときに Issue が自動で閉じられます。
Closes #42
Fixes #42
Resolves #42コミットメッセージに #42 と書いても、Issue 側にそのコミットが表示されます。「なぜこの変更をしたのか」を後からたどれるようになるので、実務ではよく使われます。
Actions ― 自動で実行する(CI/CD)
GitHub Actions は、push や PR などのタイミングで、決められた処理を GitHub のサーバー上で自動実行する 仕組みです。
よくある使い道:
- PR を作るたびにテストや lint を実行する(CI: 継続的インテグレーション)
- main にマージされたら自動でビルドしてデプロイする(CD: 継続的デリバリー/デプロイ)
- 定期的に依存パッケージの更新をチェックする
- Issue にラベルを自動で付ける
仕組み
リポジトリの .github/workflows/ に YAML ファイルを置くと、それが ワークフロー になります。
# .github/workflows/test.yml
name: Test
on: # いつ動かすか
push:
branches: [main]
pull_request:
jobs:
test: # ジョブの名前(自由)
runs-on: ubuntu-latest # どの環境で動かすか
steps:
- uses: actions/checkout@v4 # リポジトリのコードを取得
- uses: actions/setup-node@v4 # Node.js を用意
with:
node-version: 20
- run: npm ci # 依存をインストール
- run: npm test # テストを実行| 用語 | 意味 |
|---|---|
| Workflow | 1 つの YAML ファイルで定義される自動処理のまとまり |
Event(on) | 起動のきっかけ。push、pull_request、schedule(定期実行)、手動実行の workflow_dispatch など |
| Job | 1 台の実行環境で動く処理の単位。複数あれば並列に動く |
| Step | ジョブの中の 1 手順。シェルコマンド(run)か、公開されている部品(uses)を使う |
| Runner | 実際に処理を実行するマシン |
| Action | 再利用できる部品(actions/checkout など) |
PR とのつながり
ワークフローが PR に対して動くと、PR の画面に ✅(成功)や ❌(失敗)が表示されます。❌ のときは詳細のログから原因を確認し、修正を push すると自動でもう一度実行されます。
リポジトリの設定で「チェックが通らないとマージできない」ようにしておくと、壊れたコードが main に入るのを防げます。
注意点
- 秘密情報は YAML に直接書かない。 API キーなどはリポジトリ設定の Secrets に登録し、
${{ secrets.名前 }}で参照します - 他人が作った Action を
usesで使うときは、信頼できるものかを確認します。バージョンを固定しておくと安心です - 実行時間や同時実行数には、プランに応じた上限があります
その他の機能
| 機能 | ひとことで |
|---|---|
| Branch protection / Rulesets | main への直接 push を禁止する、レビュー必須にするなどのルール |
| CODEOWNERS | ファイルごとにレビュー担当者を自動で割り当てる(.github/CODEOWNERS) |
| Releases | タグに紐づけて、リリースノートや配布ファイルを公開する |
| Discussions | Issue にするほどではない質問や雑談の場 |
| Wiki | リポジトリに付属するドキュメント置き場 |
| GitHub Pages | リポジトリの内容を静的な Web サイトとして公開する |
| Dependabot | 依存パッケージの更新や脆弱性を知らせ、更新 PR を自動で作る |
| Codespaces | ブラウザから使えるクラウド上の開発環境 |
チーム開発の流れの中で
これらの機能を組み合わせると、次のような流れになります。
- やることを Issue に書く(
#42) - ブランチを切って作業し、
Closes #42を書いた PR を作る - Actions がテストを実行し、✅ になる
- レビュー で承認される
- マージすると Issue が自動で閉じる
PR そのものの流れは プルリクエストとチーム開発の流れ を参照してください。