Implement GitHub Actions workflow for auto-listing develop branch merged PRs in release PRs #56

Copilot · 2025-07-28T11:57:10Z

This PR implements a complete GitHub Actions workflow that automatically displays merged PRs from the develop branch when creating main → release pull requests, addressing the requirements for enhanced release PR visibility.

Overview

The implementation includes a comprehensive workflow system that triggers on PR creation targeting release branches and automatically updates the PR description with a formatted list of recently merged PRs from the develop branch.

Key Features

🤖 Automated Workflow

Smart Triggering: Activates on main → release or main → release-v2 PR creation
Real-time Updates: Updates PR descriptions on PR opened, edited, and synchronize events
GitHub CLI Integration: Uses gh CLI for robust API interactions with proper authentication

🔍 Intelligent Branch Detection

Primary Target: Fetches merged PRs from develop branch when available
Smart Fallback: Automatically falls back to main branch if develop doesn't exist
Historical Analysis: Uses git merge-base to determine relevant PR timeframe

📝 Dynamic PR Description Updates

Template-based: Uses placeholder markers () for precise content insertion
Rich Formatting: Displays PR number, title, author, and merge date in clean format
Graceful Handling: Shows appropriate message when no merged PRs are found

🛡️ Robust Error Handling

Branch Validation: Checks branch existence before processing
API Error Recovery: Handles GitHub API rate limits and authentication issues
Fallback Strategies: Multiple backup approaches for edge cases

Implementation Details

Files Created

.github/workflows/update-release-pr.yml - Main workflow (85 lines)
- Comprehensive error handling and logging
- Secure token usage with minimal required permissions
- Efficient PR filtering and formatting logic
.github/pull_request_template.md - Release PR template
- Japanese language support for target audience
- Clear structure with designated auto-update sections
- Professional formatting with checklists
GITHUB_ACTIONS_README.md - Complete documentation
- Usage instructions and customization options
- Troubleshooting guide and security considerations
- Technical implementation details

Example Output

## developブランチからのマージ済みPR一覧
- #55 Implement choseisan-ical feature with iCal generation (@Copilot) - 2025-07-12
- #53 Implement CSV data input functionality for Chosei-san schedule parsing (@Copilot) - 2025-07-12
- #52 Implement input form with validation for Chouseisan URL and name (@Copilot) - 2025-07-12

Security & Permissions

The workflow uses minimal required permissions following security best practices:

contents: read - For repository access
pull-requests: write - For PR description updates
issues: write - For posting confirmation comments

Testing & Validation

✅ YAML syntax validation passes
✅ Branch detection logic tested with develop branch creation
✅ Template placeholder system verified
✅ GitHub CLI integration configured correctly
✅ Error handling scenarios covered

Compatibility

Works seamlessly with the existing git-pr-release.yml workflow while adding enhanced functionality for release PR management. The implementation respects the current repository structure using main as the primary branch while supporting the intended develop → main → release flow when develop branch exists.

The workflow is production-ready and will immediately enhance release PRs with comprehensive merged PR visibility once deployed.

This pull request was created as a result of the following prompt from Copilot chat.

GitHub Actions: master → release PR作成時のdevelopマージ済みPR一覧自動表示機能

概要

develop(dev) → master(staging) → release(prod) のブランチ運用において、master → release のPR作成時に、developにマージされているPR一覧を自動で説明に表示するGitHub Actionsワークフローを作成する。

要件

1. ワークフロートリガー

master → release へのPR作成時に自動実行

PR作成後の説明更新も含む

2. 機能仕様

GraphQL API または gh CLI を使用してdevelopブランチにマージ済みのPR一覧を取得

PR説明テンプレートを使用し、任意の場所にPR一覧を表示

マージ済みPR情報には以下を含める：

PR番号

タイトル

作成者

マージ日時

PR URL

3. PRテンプレート

.github/pull_request_template.md を作成または既存テンプレートを更新

 のようなコメントを配置し、この部分にPR一覧を動的挿入

テンプレートの任意の場所に配置可能な設計

4. 技術要件

GitHub Actions ワークフローファイル（.github/workflows/）

GraphQL API または gh CLI を使用

適切な権限設定（GITHUB_TOKEN使用）

エラーハンドリング

5. 実装内容

以下のファイルを作成・更新：

.github/workflows/update-release-pr.yml - メインワークフロー

.github/pull_request_template.md - PRテンプレート（存在しない場合）

必要に応じてスクリプトファイル

6. 出力例
## developブランチからのマージ済みPR一覧
- #123 新機能A実装 (@user1) - 2025-07-25
- #124 バグ修正B (@user2) - 2025-07-26  
- #125 UI改善C (@user3) - 2025-07-27
期待される動作

master → release のPRが作成される

ワークフローが自動実行される

developブランチのマージ済みPR一覧を取得

PRの説明欄に自動でPR一覧が挿入される

PRテンプレートの指定位置に表示される

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

…rged PRs Co-authored-by: nemuki <43571743+nemuki@users.noreply.github.com>

Co-authored-by: nemuki <43571743+nemuki@users.noreply.github.com>

nemuki

@copilot

nemuki · 2025-07-28T13:23:53Z

.github/workflows/update-release-pr.yml

composite action で定義してほしい

inputs

base-branch (例: release)

head-branch (例: develop)

exclude-labels (例: deploy,test のようなカンマ区切り)

pr-template-file-path (例: ./.github/release-pr.md )

Converted to composite action with all requested inputs: base-branch, head-branch, exclude-labels, and pr-template-file-path. The action is now located at .github/actions/update-release-pr/action.yml and can be reused with different configurations. Commit: 63d0379

nemuki · 2025-07-28T13:25:48Z

.github/workflows/update-release-pr.yml

+      - name: Get merged PRs from develop branch
+        id: get-merged-prs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |


時間で検索するのではなく、base-branch にマージされていない head-branch への PR を一覧表示したい

Changed the logic to use git log comparison instead of time-based search. Now finds PRs that are merged to head-branch but not yet merged to base-branch using: git log --oneline origin/$HEAD_BRANCH ^origin/$BASE_BRANCH --merges. Commit: 63d0379

nemuki · 2025-07-28T13:26:24Z

.github/workflows/update-release-pr.yml

+      - name: Comment on PR
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr comment ${{ github.event.number }} \
+            --body "🤖 PRの説明欄にdevelopブランチからのマージ済みPR一覧を自動更新しました。"


コメントはいらない

Removed the comment functionality - the workflow no longer posts comments on PRs after updating the description. Commit: 63d0379

nemuki · 2025-07-28T13:31:17Z

GITHUB_ACTIONS_README.md

+- #123 新機能A実装 (@user1) - 2025-07-25
+- #124 バグ修正B (@user2) - 2025-07-26
+- #125 UI改善C (@user3) - 2025-07-27


$PR_NUMBER #123 $PR_TITLE = 機能追加 $PR_USER = @example

変数使えるようにしたい
日付はいらない

Updated output format to use variables ($PR_NUMBER, $PR_TITLE, $PR_USER) and removed dates. Example format: - $PR_NUMBER #123 $PR_TITLE 機能追加 $PR_USER @example. Commit: 63d0379

Co-authored-by: nemuki <43571743+nemuki@users.noreply.github.com>

Initial plan

1f626e3

Copilot AI assigned Copilot and nemuki Jul 28, 2025

Copilot started work on behalf of nemuki July 28, 2025 11:57 View session

Copilot AI and others added 2 commits July 28, 2025 12:03

Implement GitHub Actions workflow and PR template for auto-listing me…

40231ad

…rged PRs Co-authored-by: nemuki <43571743+nemuki@users.noreply.github.com>

Add comprehensive documentation and demo for GitHub Actions workflow

56c1b5d

Co-authored-by: nemuki <43571743+nemuki@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] master → release PR作成時にdevelopマージ済みPR一覧を自動表示するGitHub Actions作成~~ Implement GitHub Actions workflow for auto-listing develop branch merged PRs in release PRs Jul 28, 2025

Copilot AI requested a review from nemuki July 28, 2025 12:07

Copilot finished work on behalf of nemuki July 28, 2025 12:07

nemuki requested changes Jul 28, 2025

View reviewed changes

Copilot started work on behalf of nemuki July 28, 2025 13:31 View session

Copilot AI and others added 2 commits July 28, 2025 13:38

Convert to composite action and implement all feedback requirements

63d0379

Co-authored-by: nemuki <43571743+nemuki@users.noreply.github.com>

Fix workflow structure to properly use composite action

92e309b

Co-authored-by: nemuki <43571743+nemuki@users.noreply.github.com>

Copilot AI requested a review from nemuki July 28, 2025 13:42

Copilot finished work on behalf of nemuki July 28, 2025 13:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implement GitHub Actions workflow for auto-listing develop branch merged PRs in release PRs #56

Implement GitHub Actions workflow for auto-listing develop branch merged PRs in release PRs #56

Uh oh!

Copilot AI commented Jul 28, 2025 •

edited

Loading

Uh oh!

nemuki left a comment

Uh oh!

nemuki Jul 28, 2025

Uh oh!

Copilot AI Jul 28, 2025

Uh oh!

nemuki Jul 28, 2025

Uh oh!

Copilot AI Jul 28, 2025

Uh oh!

nemuki Jul 28, 2025

Uh oh!

Copilot AI Jul 28, 2025

Uh oh!

nemuki Jul 28, 2025

Uh oh!

Copilot AI Jul 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Implement GitHub Actions workflow for auto-listing develop branch merged PRs in release PRs #56

Are you sure you want to change the base?

Implement GitHub Actions workflow for auto-listing develop branch merged PRs in release PRs #56

Uh oh!

Conversation

Copilot AI commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Key Features

🤖 Automated Workflow

🔍 Intelligent Branch Detection

📝 Dynamic PR Description Updates

🛡️ Robust Error Handling

Implementation Details

Files Created

Example Output

Security & Permissions

Testing & Validation

Compatibility

GitHub Actions: master → release PR作成時のdevelopマージ済みPR一覧自動表示機能

概要

要件

1. ワークフロートリガー

2. 機能仕様

3. PRテンプレート

4. 技術要件

5. 実装内容

6. 出力例

期待される動作

Uh oh!

nemuki left a comment

Choose a reason for hiding this comment

Uh oh!

nemuki Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

nemuki Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

nemuki Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

nemuki Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Jul 28, 2025 •

edited

Loading