Skip to content

Add release PR workflow to auto update PR description #3607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Jun 2, 2025

Conversation

jjw24
Copy link
Member

@jjw24 jjw24 commented Jun 2, 2025

Automatically update release PR's description with the list of milestone PR title and number

@jjw24 jjw24 added this to the 1.20.0 milestone Jun 2, 2025
@jjw24 jjw24 self-assigned this Jun 2, 2025
@jjw24 jjw24 added enhancement New feature or request CI/CD labels Jun 2, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces an automated workflow that updates a release PR’s description with milestone pull request information.

  • Adds a GitHub Actions workflow (.github/workflows/release_pr.yml) triggered by pull request events and manual dispatch.
  • Implements a Python script (.github/update_release_pr.py) that fetches milestone and PR data and updates the release PR description accordingly.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
.github/workflows/release_pr.yml Adds workflow configuration to trigger and update the release PR on specific events.
.github/update_release_pr.py Implements functions to fetch GitHub milestones and PRs and update the PR description with release notes.

This comment has been minimized.

Copy link

gitstream-cm bot commented Jun 2, 2025

🥷 Code experts: no user matched threshold 10

See details

To learn more about /:\ gitStream - Visit our Docs

Copy link

gitstream-cm bot commented Jun 2, 2025

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

This comment has been minimized.

This comment has been minimized.

Jack251970
Jack251970 previously approved these changes Jun 2, 2025

This comment has been minimized.

@Jack251970 Jack251970 requested a review from Copilot June 2, 2025 12:13
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a workflow and helper script to automatically update a release pull request’s description with categorized lists of merged PR titles and numbers.

  • Introduces a GitHub Actions workflow (release_pr.yml) to trigger on PR events against master and on-demand.
  • Adds update_release_pr.py to fetch milestone PRs, format release notes, and patch the PR description.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

File Description
.github/workflows/release_pr.yml Defines when and how to run the release‐PR update job
.github/update_release_pr.py Implements logic to gather PRs, build notes, and update the PR
Comments suppressed due to low confidence (2)

.github/update_release_pr.py:6

  • The parameters label and state are declared but not used inside this function. Consider removing them or implementing filtering here to keep the API consistent.
def get_github_prs(token: str, owner: str, repo: str, label: str = "", state: str = "all") -> list[dict]:

.github/update_release_pr.py:1

  • No tests are provided for this script, making it harder to verify changes. Consider adding unit tests for core functions like get_github_prs and get_pr_descriptions.
from os import getenv

This comment has been minimized.

Jack251970
Jack251970 previously approved these changes Jun 2, 2025
Copy link

github-actions bot commented Jun 2, 2025

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors and Warnings Count
❌ forbidden-pattern 22
⚠️ non-alpha-in-dictionary 13

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

@jjw24 jjw24 requested a review from Jack251970 June 2, 2025 12:29
@jjw24 jjw24 enabled auto-merge June 2, 2025 12:30
@jjw24 jjw24 merged commit dd2560e into dev Jun 2, 2025
17 checks passed
@jjw24 jjw24 deleted the add_release_pr_workflow branch June 2, 2025 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants