chore(ci): automated chore_release PR cascade #18572

y3rsh · 2025-06-09T21:57:11Z

Overview

on:
  pull_request:
    types: [opened, reopened]

Identify PRs targeting active chore release branches which are actively kept up to date in repository variables.

Determine upstream branches handling edge as the default branch and terminating downstream branch.
Print info to the workflow summary
Auto-generate and assign the new PRs for each downstream branch.

codecov · 2025-06-09T22:28:54Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 23.84%. Comparing base (5ba6675) to head (fa97f15).
Report is 38 commits behind head on edge.

Additional details and impacted files

@@            Coverage Diff             @@
##             edge   #18572      +/-   ##
==========================================
- Coverage   24.98%   23.84%   -1.15%     
==========================================
  Files        3276     3275       -1     
  Lines      282012   280883    -1129     
  Branches    33705    33743      +38     
==========================================
- Hits        70471    66974    -3497     
- Misses     211515   213884    +2369     
+ Partials       26       25       -1

Flag	Coverage Δ
app	`0.33% <ø> (-1.95%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 177 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

y3rsh · 2025-06-10T13:26:40Z

scripts/chore_release_pr_gen.py

+    # Remove default_branch if present downstream
+    # This is a clean way to:
+    # - set the default branch at the end
+    # - handle someone including the default branch in the branch_list
+    # - set downstream to [] if target_branch is the default, as it is in most cases
+    downstream = [b for b in downstream if b != default_branch]
+    # Append default_branch if target_branch is not already the default
+    if target_branch != default_branch:
+        downstream.append(default_branch)
+    return downstream


I think I might prefer having the default in the repository variable and not doing any manipulation in the script.

the default branch is actually the github repo option default branch, which you can retrieve from repo properties - then we don't even have to put it in the repo args

I think I prefer it in the repo variable as the source of truth of the branch cascade vs understanding rare knowledge about the default branch of the repository as always the last element.

sfoster1

couple little things but i think the important one is getting the full pr body in the created branches

.github/workflows/chore-release-pr-automation.yaml

sfoster1 · 2025-06-10T13:37:28Z

scripts/chore_release_pr_gen.py

+    """Splits a comma-separated branch list into a clean Python list."""
+    return [b.strip() for b in branch_list_str.split(",") if b.strip()]
+
+def get_downstream_branches(branch_list: List[str], target_branch: str, default_branch: str = DEFAULT_BRANCH) -> List[str]:


not really a thing for a one-off script like this but you usually want default values in python to be None - since python name binds by reference, if you were to do default_branch.strip() and default_branch was bound to DEFAULT_BRANCH, the string in DEFAULT_BRANCH would be persistently modified.

sfoster1 · 2025-06-10T13:41:02Z

scripts/chore_release_pr_gen.py

+    # Remove default_branch if present downstream
+    # This is a clean way to:
+    # - set the default branch at the end
+    # - handle someone including the default branch in the branch_list
+    # - set downstream to [] if target_branch is the default, as it is in most cases
+    downstream = [b for b in downstream if b != default_branch]
+    # Append default_branch if target_branch is not already the default
+    if target_branch != default_branch:
+        downstream.append(default_branch)
+    return downstream


the default branch is actually the github repo option default branch, which you can retrieve from repo properties - then we don't even have to put it in the repo args

scripts/chore_release_pr_gen.py

sfoster1

Nice! Looks good to me!

sfoster1 · 2025-06-10T15:10:34Z

scripts/chore_release_pr_gen.py

+    import sys
+
+    if len(sys.argv) > 1 and sys.argv[1] == "test":
+        unittest.main(argv=[sys.argv[0]])


oh this is cool, i like it

ddcc4 · 2025-06-10T19:09:00Z

.github/workflows/chore-release-pr-automation.yaml

+              --base "$branch" \
+              --head "${{ github.event.pull_request.head.ref }}" \
+              --title "${{ github.event.pull_request.title }} into $branch" \
+              --body "${{ github.event.pull_request.body }} \


Is it worth mentioning the original PR number somewhere in the new PRs, so that future readers know how they're related?

Yes I think I will add it at the top of the body.

ddcc4 · 2025-06-10T19:11:53Z

.github/workflows/chore-release-pr-automation.yaml

+          for branch in $downstream_branches; do
+            pr_url=$(gh pr create \
+              --base "$branch" \
+              --head "${{ github.event.pull_request.head.ref }}" \


Hm, I'm not so familiar with Github's model, but does this mean that as far as Github knows, the same author's branch is going to be used for all the PRs?

What happens if the code needs to be tweaked differently for the different downstream_branches?

Yes, the same branch is used and the author will be expected to create a commit or commits to resolve conflicts and tweak as needed. The PR(s) are the TODO to make sure that gets done. As discussed if we move to normal merges, folks will need to be careful to preserve all the commits as they proceed through the PRs.

As I have now remarked in the epic slack thread, if we are normal merging, I do not see this automation as helpful in its current form.

y3rsh added 4 commits June 9, 2025 15:32

chore(ci): automated chore_release PR cascade

b400edd

on push

5f7f190

better output

998b9b8

ready for some eyes

da56d90

y3rsh self-assigned this Jun 9, 2025

y3rsh requested review from a team as code owners June 9, 2025 21:57

y3rsh added 3 commits June 9, 2025 16:58

bad file name

453c2a0

edited

becec10

newline

fa97f15

y3rsh commented Jun 10, 2025

View reviewed changes

sfoster1 requested changes Jun 10, 2025

View reviewed changes

y3rsh added 3 commits June 10, 2025 08:58

logic and tests

7ffd5fd

much better

d9a6586

re-order output code

a8f77d6

y3rsh requested a review from sfoster1 June 10, 2025 14:58

sfoster1 approved these changes Jun 10, 2025

View reviewed changes

ddcc4 reviewed Jun 10, 2025

View reviewed changes

add PR num to body

cfc2403

chore(ci): automated chore_release PR cascade #18572

Are you sure you want to change the base?

chore(ci): automated chore_release PR cascade #18572

Uh oh!

Conversation

y3rsh commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Uh oh!

codecov bot commented Jun 9, 2025

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfoster1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sfoster1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

y3rsh commented Jun 9, 2025 •

edited

Loading