0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

GitHub Issues・Projects・Actionsでタスク管理を自動化する

0
Posted at

GitHub Issues・Projects・Actionsでタスク管理を自動化する

GitHubでチーム開発を進める際、Issue・作業ブランチ・Pull Requestを紐付けておくと、作業の目的や進捗を追いやすくなります。

さらに、GitHub ActionsでProjectsのステータスを更新すれば、作業のたびに手動でステータスを変更する手間を減らせます。

本記事では、タスクの作成からレビュー・完了までの運用ルールと、Organization Projectsのステータスを自動更新するWorkflowの導入方法を紹介します。

認証情報はSecretで管理し、ログにはIssueやProjectのタイトルを出力しない構成にします。

1. 運用の全体像

基本の流れは、次のとおりです。

Issue作成
    ↓
Backlog / Readyを設定(手動)
    ↓
issue-番号 ブランチを作成・push
    ↓
In progress(自動)
    ↓
Pull Requestを作成
    ↓
In review(自動)
    ↓
レビュー・マージ
    ↓
Done(自動)

操作とステータスの対応は、以下のようにします。

操作 Projectsのステータス
Issueを登録し、着手時期を判断 Backlog / Ready(手動)
issue-番号 ブランチをpush In progress(自動)
Pull Requestを作成 In review(自動)
Pull Requestをマージ Done(自動)

BacklogとReadyの判断・設定は手動で行います。着手後のステータスは、原則としてGitHub Actionsに任せます。

本記事の前提

  • Organization所有のProjectsを使用する
  • デフォルトブランチは main とする
  • 基本的に、1つのIssueに対して1つの作業ブランチ・Pull Requestを作成する
  • 作業ブランチは対象リポジトリ内に作成する
  • Issueは、作業ブランチと同じリポジトリに作成する
  • 対象Issueは、あらかじめProjectへ追加しておく
  • リポジトリへの書き込み権限は、認証情報の利用を許可できるメンバーに限定する

今回のWorkflowが更新するのは、Issueに対応するProjectアイテムのStatusフィールドです。

Issueの作成・Projectへの追加・Issueのクローズは、このWorkflowには含まれません。

2. タスクを作成する(Issue起票)

対象リポジトリの Issues → New issue からIssueを作成します。

2-1. タイトル・内容を記入する

タイトルには、何をするかを一行で記載します。

本文には、以下の内容を記載してください。

項目 記載する内容
背景 なぜ対応が必要なのか
やること 対応範囲と具体的な作業
完了条件 何を確認できれば完了とするか

記載例:

## 背景
検索結果が0件の場合、画面に何も表示されず、
利用者が検索処理の完了を判断できない。

## やること
- 検索結果が0件の場合に案内メッセージを表示する
- 表示内容を確認する

## 完了条件
- 検索結果が0件の場合に案内メッセージが表示される
- 検索結果がある場合の表示に影響がない
- 必要なテストが完了している

2-2. ラベルを付ける

本運用では、種類と優先度のラベルを付けます。

分類 ラベル 用途
種類 bug バグ修正
種類 feature 新規開発
種類 fix 仕様調整
優先度 High 高
優先度 Medium 中
優先度 Low 低

リポジトリに存在しないラベルは、事前に作成してください。

2-3. 担当者を設定する

Assigneeに実作業者を設定します。

2-4. Projectsに追加する

Issueを対象のProjectに追加し、以下のどちらかを設定します。

ステータス 判断基準
Backlog 期限が決まっていない、今後対応する予定のタスク
Ready 期限が決まっていて、すぐに着手するタスク

3. 作業に着手する

担当者は、最新の main ブランチから作業ブランチを作成します。

3-1. ブランチ名をIssue番号に合わせる

ブランチ名は、必ず以下の形式にします。

issue-番号

Issue番号が 70 の場合:

issue-70

作成例:

git switch main
git pull --ff-only origin main
git switch -c issue-70

変更をコミットしてpushすると、Projectsのステータスが In progress に更新されます。

git push -u origin issue-70

ブランチを作成しただけでは更新されません。GitHubへpushしたタイミングでWorkflowが実行されます。

3-2. Priority・Size・Estimateを設定する

着手時に、ProjectsのPriority・Size・Estimateを入力します。

これらの項目は、チームの運用に合わせてProject側に用意してください。

Priority:優先順位

Priority 意味 具体例
P0 最優先(Critical) 本番障害、サービス停止、即時対応が必要
P1 高 主要機能が使えない、期限が近い
P2 中 通常タスク、改善
P3 低 余裕があれば対応する、将来対応

Issueの優先度ラベルとProjectsのPriorityは別の項目です。両方を使う場合は、チーム内で判断基準をそろえます。

Size:作業規模

Size 目安時間 内容の例
XS 1〜2時間 文言修正、設定変更
S 半日程度まで 軽微なロジック修正
M 1日 APIを1本追加、画面を1枚作成
L 2〜3日 複数箇所の修正、影響範囲の広い変更
XL 1週間以上 調査が多い、不確実性が高い作業

3日以上かかりそうなIssueは、できるだけ小さなIssueに分割します。

Estimate:見積もりポイント

本運用では、以下を目安に設定します。

Point 目安
1 数十分〜1時間
2 半日
3 1日
5 2〜3日
8 1週間弱
13 不確実性が高い

4. 作業中の進捗を共有する

進捗はIssueのコメントに記録します。

  • 完了した作業
  • 次に対応する作業
  • 調査中の内容
  • 詰まっていることや相談事項

作業が止まっている場合は、原因や確認済みの内容も残しておくと、ほかのメンバーが支援しやすくなります。

認証情報や個人情報などは、Issueやコメントに記載しないようにします。

5. Pull Requestを作成する

作業と必要なテストが完了したら、作業ブランチから main に向けてPull Requestを作成します。

本文には、変更内容・確認結果・対象Issueを記載します。

## 変更内容
- 検索結果が0件の場合に案内メッセージを表示

## 確認結果
- 検索結果が0件の場合の表示を確認
- 検索結果がある場合の表示を確認
- 関連するテストが成功

## 対象Issue
Closes #70

Closes #70 のようなキーワードを使うと、デフォルトブランチへのマージ時に対象Issueを自動クローズできます。キーワードによる紐付けは、Pull Requestがデフォルトブランチを対象とする場合に有効です。GitHub公式ドキュメント

Pull Requestを作成すると、Projectsのステータスが In review に更新されます。

レビュー対応で追加のpushを行っても、In progressには戻さないようにします。

6. レビュー・完了確認を行う

レビュワーは変更内容を確認し、問題がなければPull Requestをマージします。

マージ後は、以下を確認してください。

  • Projectsのステータスが Done になっている
  • 対象Issueがクローズされている

この2つは別の処理です。

Projectsの更新は今回のWorkflowが行い、Issueの自動クローズはPull Requestの紐付けとGitHubの機能を利用します。

7. 自動更新の準備をする

7-1. ProjectsのStatusフィールドを確認する

対象Projectに、単一選択形式の Status フィールドと、以下の選択肢を用意します。

Backlog
Ready
In progress
In review
Done

Workflowが更新先として使用するのは、以下の3つです。

In progress
In review
Done

フィールド名と選択肢名は、大文字・小文字やスペースを含めてコードと一致させてください。

たとえば、Project側が In Progress、コード側が In progress では一致しません。

7-2. Organization名とProject番号を確認する

対象ProjectのURLを確認します。

https://github.com/orgs/YOUR_ORGANIZATION/projects/2

この場合の設定値は、以下のとおりです。

設定項目 値
PROJECT_OWNER YOUR_ORGANIZATION
PROJECT_NUMBER 2

後述のWorkflow内で、この2つを自分の環境に合わせて変更します。

7-3. 認証方式を決める

Organization Projectsの認証には、GitHub Appの利用が推奨されています。GitHub公式ドキュメント

本記事の掲載コードは、Personal Access Token(classic)を使用する例です。GitHub Appで利用する場合は、Appのインストールアクセストークンを生成し、GH_TOKEN に渡す構成へ変更します。

本番運用では、次の方針で認証方式を選びます。

  • GitHub Appを優先して検討する
  • 対象リポジトリと必要な権限を限定する
  • Organization Projects権限が及ぶ範囲も確認する
  • PATを使う場合は、所有者のアクセス権を必要な範囲に抑える
  • 個人の広範な権限を持つPATを、複数リポジトリへ安易に共有しない

PAT(classic)は、登録先のリポジトリだけにアクセスを限定する方式ではありません。スコープと所有者の権限に応じて、ほかのリポジトリにもアクセスできます。GitHubのPAT管理ドキュメント

7-4. PATを作成する

PATを使用する場合は、以下の手順で作成します。

  1. GitHubにログインします。
  2. 右上のプロフィールアイコンから Settings を開きます。
  3. Developer settings を開きます。
  4. Personal access tokens → Tokens (classic) を選択します。
  5. Generate new token → Generate new token (classic) をクリックします。

Personal access tokensの設定画面からもアクセスできます。

設定内容は以下のとおりです。

設定項目 設定内容
Note GitHub-Actions-Project-Status
Expiration 組織の運用ルールに従い、有効期限を設定
Select scopes repo、project

GitHub公式のPATを使用するProjects自動化例でも、repo と project スコープを指定しています。GitHub公式ドキュメント

トークンの所有者には、対象リポジトリの参照と対象Projectの更新ができる権限も必要です。

設定後、Generate token をクリックし、生成されたトークンを安全に管理します。

  • ソースコード・Issue・チャットなどにトークンを記載しないでください。
  • OrganizationのPAT利用制限やSSO認可の要否を確認してください。
  • 有効期限・管理者・更新担当者を決めてください。
  • 期限切れや再発行の際は、登録済みSecretも更新してください。

7-5. Secretを登録する

対象リポジトリで、以下の操作を行います。

  1. Settings を開きます。
  2. Secrets and variables → Actions を開きます。
  3. Secrets タブから New repository secret をクリックします。
  4. 以下の内容で登録します。
項目 設定値
Name PROJECT_TOKEN
Secret 作成したPAT

最後に Add secret をクリックします。詳しい画面操作は、GitHub公式ドキュメントも参照してください。

Secretへの保存は、Workflowを変更できる人によるトークンの利用まで防ぐ仕組みではありません。リポジトリへの書き込み権限を持つ人は、Workflowを通じてSecretを利用できるため、メンバーの権限管理も必要です。GitHubのセキュリティガイド

8. Workflowファイルを配置する

対象リポジトリに、以下のファイルを作成します。

.github/workflows/project-status.yml

掲載コードでは、次の点に配慮しています。

  • permissions: {} で、自動発行される GITHUB_TOKEN の不要な権限を抑える
  • ブランチ名などは環境変数を経由してスクリプトへ渡す
  • トークンは更新処理のステップにだけ渡す
  • Issue・Projectのタイトルや、関連Projectの一覧をログへ出さない
  • APIの更新結果を標準出力へそのまま出さない
  • ブランチ削除時のpushイベントは処理しない

なお、permissions: {} は PROJECT_TOKEN の権限を制限するものではありません。PATの権限は、PAT自体の設定と所有者のアクセス権で管理します。

PROJECT_OWNER と PROJECT_NUMBER を変更して使用してください。

name: Update Project Status

permissions: {}

on:
  push:
    branches:
      - 'issue-*'

  pull_request:
    types:
      - opened
      - reopened
      - ready_for_review
      - closed

jobs:
  update-project-status:
    runs-on: ubuntu-latest

    if: >
      (github.event_name == 'push' && github.event.deleted == false) ||
      (github.event_name == 'pull_request' &&
        (github.event.action == 'opened' ||
         github.event.action == 'reopened' ||
         github.event.action == 'ready_for_review' ||
         (github.event.action == 'closed' &&
          github.event.pull_request.merged == true)))

    steps:
      - name: Resolve issue and target status
        id: info
        shell: bash
        env:
          EVENT_NAME: ${{ github.event_name }}
          EVENT_ACTION: ${{ github.event.action }}
          PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
        run: |
          set -euo pipefail

          if [ "$EVENT_NAME" = "push" ]; then
            BRANCH="$GITHUB_REF_NAME"
            STATUS="In progress"
          else
            BRANCH="$PR_HEAD_REF"

            if [ "$EVENT_ACTION" = "closed" ]; then
              STATUS="Done"
            else
              STATUS="In review"
            fi
          fi

          if [[ "$BRANCH" =~ ^issue-([0-9]+)$ ]]; then
            ISSUE_NUMBER="${BASH_REMATCH[1]}"
          else
            echo "SKIP: Branch must match issue-{number}."
            exit 0
          fi

          echo "Issue: #$ISSUE_NUMBER"
          echo "Target status: $STATUS"

          echo "issue_number=$ISSUE_NUMBER" >> "$GITHUB_OUTPUT"
          echo "status=$STATUS" >> "$GITHUB_OUTPUT"

      - name: Update project status
        if: steps.info.outputs.issue_number != ''
        shell: bash
        env:
          GH_TOKEN: ${{ secrets.PROJECT_TOKEN }}

          # 自分のOrganization名とProject番号に変更する
          PROJECT_OWNER: YOUR_ORGANIZATION
          PROJECT_NUMBER: '2'

          ISSUE_NUMBER: ${{ steps.info.outputs.issue_number }}
          TARGET_STATUS: ${{ steps.info.outputs.status }}
          REPO_OWNER: ${{ github.repository_owner }}
          REPO_NAME: ${{ github.event.repository.name }}
        run: |
          set -euo pipefail

          if [ -z "${GH_TOKEN:-}" ]; then
            echo "ERROR: PROJECT_TOKEN is not available."
            exit 1
          fi

          echo "STEP 1: Fetch Project settings"

          PROJECT_DATA=$(gh api graphql \
            -f query='
              query($owner: String!, $number: Int!) {
                organization(login: $owner) {
                  projectV2(number: $number) {
                    id
                    fields(first: 50) {
                      nodes {
                        ... on ProjectV2SingleSelectField {
                          id
                          name
                          options {
                            id
                            name
                          }
                        }
                      }
                    }
                  }
                }
              }' \
            -f owner="$PROJECT_OWNER" \
            -F number="$PROJECT_NUMBER")

          PROJECT_ID=$(echo "$PROJECT_DATA" |
            jq -r '.data.organization.projectV2.id // empty')

          if [ -z "$PROJECT_ID" ]; then
            echo "STEP 1 FAILED: Project was not found."
            exit 1
          fi

          STATUS_FIELD_ID=$(echo "$PROJECT_DATA" |
            jq -r '
              .data.organization.projectV2.fields.nodes[]
              | select(.name == "Status")
              | .id
            ')

          if [ -z "$STATUS_FIELD_ID" ]; then
            echo "STEP 1 FAILED: Status field was not found."
            exit 1
          fi

          STATUS_OPTION_ID=$(echo "$PROJECT_DATA" |
            jq -r --arg status "$TARGET_STATUS" '
              .data.organization.projectV2.fields.nodes[]
              | select(.name == "Status")
              | .options[]
              | select(.name == $status)
              | .id
            ')

          if [ -z "$STATUS_OPTION_ID" ]; then
            echo "STEP 1 FAILED: Target status option was not found."
            exit 1
          fi

          echo "STEP 1 OK"

          echo "STEP 2: Fetch Issue and Project item"

          ISSUE_DATA=$(gh api graphql \
            -f query='
              query(
                $owner: String!,
                $repo: String!,
                $number: Int!
              ) {
                repository(owner: $owner, name: $repo) {
                  issue(number: $number) {
                    id
                    projectItems(first: 50, includeArchived: true) {
                      nodes {
                        id
                        isArchived
                        project {
                          id
                        }
                        fieldValueByName(name: "Status") {
                          ... on ProjectV2ItemFieldSingleSelectValue {
                            name
                          }
                        }
                      }
                    }
                  }
                }
              }' \
            -f owner="$REPO_OWNER" \
            -f repo="$REPO_NAME" \
            -F number="$ISSUE_NUMBER")

          ISSUE_ID=$(echo "$ISSUE_DATA" |
            jq -r '.data.repository.issue.id // empty')

          if [ -z "$ISSUE_ID" ]; then
            echo "STEP 2 FAILED: Issue was not found."
            exit 1
          fi

          ITEM_DATA=$(echo "$ISSUE_DATA" |
            jq -c --arg project_id "$PROJECT_ID" '
              [
                .data.repository.issue.projectItems.nodes[]
                | select(.project.id == $project_id)
              ]
              | .[0] // empty
            ')

          if [ -z "$ITEM_DATA" ]; then
            echo "STEP 2 FAILED: Issue is not in the target Project."
            exit 1
          fi

          ITEM_ID=$(echo "$ITEM_DATA" |
            jq -r '.id')

          CURRENT_STATUS=$(echo "$ITEM_DATA" |
            jq -r '.fieldValueByName.name // ""')

          IS_ARCHIVED=$(echo "$ITEM_DATA" |
            jq -r '.isArchived')

          if [ "$IS_ARCHIVED" = "true" ]; then
            echo "STEP 2 FAILED: Project item is archived."
            exit 1
          fi

          echo "STEP 2 OK"

          echo "STEP 3: Check whether update is necessary"

          if [ "$TARGET_STATUS" = "In progress" ]; then
            if [ "$CURRENT_STATUS" = "In review" ] ||
               [ "$CURRENT_STATUS" = "Done" ]; then
              echo "STEP 3 SKIP: Push must not reset review or completion."
              exit 0
            fi
          fi

          if [ "$CURRENT_STATUS" = "$TARGET_STATUS" ]; then
            echo "STEP 3 SKIP: Already at the target status."
            exit 0
          fi

          echo "STEP 3 OK"

          echo "STEP 4: Update Project status"

          gh api graphql \
            -f query='
              mutation(
                $project: ID!,
                $item: ID!,
                $field: ID!,
                $option: String!
              ) {
                updateProjectV2ItemFieldValue(
                  input: {
                    projectId: $project
                    itemId: $item
                    fieldId: $field
                    value: {
                      singleSelectOptionId: $option
                    }
                  }
                ) {
                  projectV2Item {
                    id
                  }
                }
              }' \
            -f project="$PROJECT_ID" \
            -f item="$ITEM_ID" \
            -f field="$STATUS_FIELD_ID" \
            -f option="$STATUS_OPTION_ID" \
            > /dev/null

          echo "STEP 4 OK"
          echo "Updated Issue #$ISSUE_NUMBER to $TARGET_STATUS."

ファイルを配置したら main に反映し、その後に作成する作業ブランチにもWorkflowが含まれる状態にします。

複数リポジトリを対象とする場合は、それぞれにWorkflowを配置します。認証情報は、リポジトリごとの必要なアクセス範囲を確認したうえで設定してください。

9. Workflowの仕組み

9-1. イベントから更新先を決定する

イベント 更新先・動作
作業ブランチへのpush In progress
Pull Requestの作成 In review
Pull Requestの再オープン In review
Draftからレビュー可能な状態への変更 In review
Pull Requestのマージ Done
マージせずにPull Requestをクローズ 更新しない
作業ブランチの削除 更新しない

ブランチ名が issue-番号 に一致しない場合は、更新せずに終了します。

9-2. ブランチ名からIssue番号を取得する

push時はpush先のブランチ名、Pull Requestのイベント時は作業元のブランチ名を使用します。

if [[ "$BRANCH" =~ ^issue-([0-9]+)$ ]]; then
  ISSUE_NUMBER="${BASH_REMATCH[1]}"
fi

判定例:

ブランチ名 判定
issue-70 Issue #70 を更新対象にする
issue-123 Issue #123 を更新対象にする
issue-70-feature 対象外
feature/issue-70 対象外
main 対象外

Pull Request本文の Closes #70 は、WorkflowのIssue番号判定には使用しません。

作業ブランチ名・Pull Requestの紐付け先・実際の作業対象を一致させることが運用上のポイントです。

9-3. 外部入力をスクリプトへ直接埋め込まない

ブランチ名は、次のように環境変数を経由して渡します。

env:
  PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
BRANCH="$PR_HEAD_REF"

run: 内にブランチ名などを直接展開すると、入力内容がスクリプトとして解釈される危険があります。環境変数を経由し、シェル側でも引用して扱います。GitHubのスクリプトインジェクション対策

9-4. 更新対象を確認する

GitHub CLIの gh api graphql を使って、以下を取得します。

  • ProjectのID
  • StatusフィールドのID
  • 更新先の選択肢ID
  • Issueの存在
  • Issueに対応するProjectアイテムのID
  • 現在のステータス
  • アーカイブ状態

Project・Statusフィールド・選択肢が見つからない場合は、エラーで終了します。

対象IssueがProjectに登録されていない場合や、アーカイブされている場合も更新しません。

9-5. 追加pushによる差し戻しを防ぐ

push時は、現在のステータスが In review または Done なら、In progressへの変更をスキップします。

if [ "$TARGET_STATUS" = "In progress" ]; then
  if [ "$CURRENT_STATUS" = "In review" ] ||
     [ "$CURRENT_STATUS" = "Done" ]; then
    exit 0
  fi
fi

これにより、レビュー対応の追加pushや、完了後のpushでステータスが戻るのを防ぎます。

現在のステータスと更新先が同じ場合も、更新処理をスキップします。

9-6. Statusフィールドを更新する

更新が必要な場合は、GraphQLの updateProjectV2ItemFieldValue を呼び出し、Statusフィールドの選択肢を変更します。

Issueのクローズや、Pull Requestのマージ自体を行う処理はありません。

10. 動作確認を行う

掲載コードは、自分のOrganization・Project・権限設定に合わせて動作確認してから運用へ導入してください。

  1. 対象リポジトリにテスト用Issueを作成します。
  2. Issueを対象Projectに追加し、Readyを設定します。
  3. 最新の main から、対応する issue-番号 ブランチを作成します。
  4. マージしても問題のない変更をコミットしてpushします。
  5. ステータスが In progress になることを確認します。
  6. Pull Requestを作成し、本文に Closes #番号 を記載します。
  7. ステータスが In review になることを確認します。
  8. 追加の変更をコミットしてpushします。
  9. ステータスが In reviewのまま であることを確認します。
  10. レビュー後にPull Requestを main へマージします。
  11. ステータスが Done になり、Issueがクローズされることを確認します。

Actionsの実行成功だけでなく、ProjectsとIssueの表示も確認してください。

11. ステータスが更新されない場合

対象リポジトリの Actions タブから、該当Workflowの実行履歴を開きます。

ログは、以下の4段階に分かれています。

ログ 処理内容
STEP 1 Project・Statusフィールド・選択肢の取得
STEP 2 Issue・Projectアイテムの取得とアーカイブ状態の確認
STEP 3 更新が必要かの判定
STEP 4 Statusフィールドの更新

確認する項目は以下のとおりです。

確認項目 確認内容
Workflow .github/workflows/ 配下にあり、対象ブランチにも含まれているか
Projectの設定 PROJECT_OWNER と PROJECT_NUMBER が正しいか
Secret PROJECT_TOKEN が利用できる状態か
トークンの権限 必要なスコープ・アクセス権があるか
トークンの期限 有効期限が切れていないか
Organizationの設定 PATの利用制限やSSO認可に問題がないか
ブランチ名 issue-番号 の形式で、対象Issue番号と一致しているか
Issueの登録 Issueが対象Projectに追加されているか
アーカイブ 対象のProjectアイテムがアーカイブされていないか
Statusの名称 フィールド名・選択肢名がコードと完全一致しているか

正常終了でも、ログに SKIP が出ている場合は更新していません。

調査のためにログを追加する場合も、トークンやAPIレスポンス全体、非公開のIssue・Project情報を出力しないようにします。エラーログや画面のスクリーンショットを共有する際も、内容を確認してください。

12. 運用上の注意点

DraftのPull RequestもIn reviewになる

今回のWorkflowでは、Draftであっても作成時の opened イベントでIn reviewに更新します。

Draftの間はIn progressを維持したい場合は、Draftを判定する条件を追加してください。

In reviewからDraftへ戻した場合に、In progressへ戻す処理も含めていません。

マージ先による制限は設けていない

このWorkflowは、Pull Requestのマージ先ブランチを制限していません。

対象のブランチ名に一致するPull Requestがマージされると、マージ先にかかわらずDoneになります。

本記事では main へのPull Requestを前提としています。ほかのブランチへのPull Requestも作成する運用では、マージ先の条件を追加してください。

マージせずに閉じた場合は手動で判断する

Pull Requestをマージせずにクローズした場合、ステータスはそのままです。

タスクを中止・保留にする場合などは、理由をIssueに記載したうえで、必要に応じて手動でステータスを調整します。

再オープン時はIn reviewに更新する

追加pushによる差し戻し防止は、更新先がIn progressの場合に適用されます。

Pull Requestを再オープンした場合は、現在のステータスがDoneでもIn reviewへ更新します。

ForkからのPull Requestは対象にしていない

本記事は、同じリポジトリ内に作業ブランチを作成する運用を前提としています。

ForkからのPull Requestでは、通常、PROJECT_TOKEN のようなSecretは渡されません。GitHub公式ドキュメント

Secretを渡すためだけに、実行イベントを安易に pull_request_target へ変更しないでください。権限のあるWorkflowで信頼できないコードを実行すると、認証情報の流出につながる可能性があります。GitHubのセキュリティガイド

大規模な構成ではページネーションを追加する

掲載コードは、ProjectのフィールドとIssueに紐付くProjectアイテムを、それぞれ先頭50件まで取得します。

取得対象が50件を超える場合は、ページネーションを実装してください。

同時実行時の順序は保証していない

現在のコードは、取得したステータスを確認してから更新する方式です。

複数のWorkflowが同時実行される場合に、読み取りと更新の順序を保証する仕組みは含んでいません。

短時間にpush・Pull Request作成・マージを続けて行う運用では、実行順序の制御や更新直前の再確認などを検討してください。

Workflowを変更できる人の権限を管理する

Secretを利用するWorkflowでは、リポジトリへの書き込み権限を持つ人を、認証情報の利用を許可できるメンバーに限定します。

あわせて、Workflowの変更はレビュー対象にします。ただし、main のブランチ保護だけで、作業ブランチ上のWorkflowによるSecret利用まで防げるわけではありません。

ログに必要以上の情報を出さない

掲載コードでは、Issue・Projectのタイトルや関連Projectの一覧は取得・出力していません。

ただし、Issue番号やステータス、GitHubが生成する実行情報やAPIのエラーメッセージまで、すべて非表示になるわけではありません。

公開リポジトリではログも公開される前提で、Workflowとログの内容を確認してください。

認証情報の更新・失効に対応する

トークンの有効期限を管理し、期限切れ前に更新します。

再発行した場合は PROJECT_TOKEN も更新してください。流出が疑われる場合は、Secretの差し替えだけでなく、元のトークンを失効させます。

13. チームで共有する運用ルール

日々の作業では、以下を共通ルールにします。

  • タスクはIssueとして作成し、背景・やること・完了条件を記載する
  • ラベル・担当者を設定し、対象Projectに追加する
  • BacklogとReadyは手動で判断する
  • 作業ブランチは main から作成し、issue-番号 の形式にする
  • 進捗や詰まりポイントはIssueにコメントする
  • Pull Requestには変更内容・確認結果・対象Issueを記載する
  • レビュー後にマージし、ProjectsのDoneとIssueのクローズを確認する
  • 認証情報の権限・有効期限・利用者を管理する
  • Issue・コメント・ログに機密情報を残さない

Issueから実装・レビュー・完了までを紐付け、認証情報と公開範囲を管理しながら、着手後のステータス更新を自動化します。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?