[ci] Adds github action for creating batch release #10298

chunhtai · 2025-10-24T18:02:28Z

To set up a batch release cron job for a package, one needs to make a copy of packages/.github/workflows/go_router_batch.yml, and change the name and cron schedule.

The cron job does the following:

trigger batch_release_pr.yaml with the input package

batch_release_pr:

check out repo
Run script/tool/lib/src/branch_for_batch_release_command.dart to create branches with all the changes
create pr request

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩² ↩³

chunhtai · 2025-10-27T22:46:00Z

reason for override: ci only change

.github/workflows/batch_release_pr.yml

stuartmorgan-g · 2025-10-28T14:05:19Z

.github/workflows/batch_release_pr.yml

+  create_release_pr:
+    runs-on: ubuntu-latest
+    env:
+      BRANCH_NAME: ${{ github.event.client_payload.package }}-${{ github.run_id }}-${{ github.run_attempt }}


So the cron job is constantly creating new branches? What cleans up branches that don't actually end up published?

I see that can be a problem. then I think the right thing to do will be re-use the same branch name and do a clean up before creating a new release

filed flutter/flutter#177748

stuartmorgan-g · 2025-10-28T14:08:12Z

packages/go_router/pending_changelogs/test_only_1.yaml

If these files are going to be created as part of the PR process, then the tooling should be updated to understand that, and the override labels shouldn't be needed on this PR. If the PR isn't landable without overrides, then the normal commit path isn't working correctly.

yes, that part of the work will be in flutter/flutter#176433.

Usually if a change to repo structure requires updates to our checks we do those two things in the same PR rather than override our own tooling, so it's not clear to me why this is being done separately. That said, since it's isolated to this package and shouldn't affect any normal PRs for now I guess it's fine.

The reason I don't do the ci check before this pr is that I would like to finalize the yaml content first, and it can't be finalized until the approach of this PR is reviewed and approved.

and I think doing it as part of this pr may be too distracting for reviewer

script/tool/lib/src/batch_command.dart

stuartmorgan-g · 2025-10-28T14:30:19Z

script/tool/lib/src/batch_command.dart

+
+    print('  Pushing to remote...');
+    final io.ProcessResult pushResult =
+        await repository.runCommand(<String>['push', 'origin', branchName, '--force']);


Here too, --force seems needlessly dangerous. I don't see why we would need to enable this command to be destructive.

stuartmorgan-g · 2025-10-28T14:33:28Z

script/tool/lib/src/batch_command.dart

+      throw FormatException('Expected "changelog" to be a list, but found ${changelogYaml.runtimeType}.');
+    }
+    final List<String> changelog = changelogYaml.nodes
+        .map((YamlNode node) => node.value as String)


What happened to allowing arbitrary markdown? How would someone make this changelog for instance?

we can use | for arbitrary markdown in yaml will need to check whether dart yaml support this properly. now I think of it maybe the changelog part of the yaml shouldn't be a list, it should just be a single element that accept arbitrary markdown.

version: major changelogs: | my *markdown* - item **one** - item two

.github/workflows/batch_release_pr.yml

script/tool/test/branch_for_batch_release_command_test.dart

script/tool/lib/src/branch_for_batch_release_command.dart

script/tool/test/branch_for_batch_release_command_test.dart

chunhtai · 2025-11-10T20:12:27Z

.github/workflows/batch_release_pr.yml

+          dart ./script/tool/lib/src/main.dart branch-for-batch-release --packages=${{ github.event.client_payload.package }} --branch=${{ env.BRANCH_NAME }} --remote=origin
+      - name: Check if branch was created
+        id: check-branch-exists
+        uses: GuillaumeFalourd/[email protected]


I am new to GA, not sure if we are allowed to use GA from marketplace, let me know if this is not allowed.

Also is there a way to test this locally?

github-actions bot added p: go_router triage-framework Should be looked at in framework triage labels Oct 27, 2025

chunhtai added override: no versioning needed Override the check requiring version bumps for most changes override: no changelog needed Override the check requiring CHANGELOG updates for most changes labels Oct 27, 2025

chunhtai requested a review from stuartmorgan-g October 27, 2025 22:50

stuartmorgan-g reviewed Oct 28, 2025

View reviewed changes

chunhtai force-pushed the issues/176425 branch 2 times, most recently from 7be1e87 to 5853905 Compare October 30, 2025 17:12

chunhtai marked this pull request as ready for review October 30, 2025 17:13

chunhtai requested a review from stuartmorgan-g October 30, 2025 17:13

chunhtai changed the title ~~[WIP] Adds github action for creating batch release~~ [ci] Adds github action for creating batch release Oct 30, 2025

stuartmorgan-g requested changes Nov 7, 2025

View reviewed changes

chunhtai force-pushed the issues/176425 branch from 5853905 to 48eb6ab Compare November 8, 2025 00:23

chunhtai added 16 commits November 10, 2025 09:41

Adds github action for creating batch release

d7e04d5

adds github workflow for batch release

cb2457f

push change

18bd231

update

2110fff

update

f8dc770

update

4c28a8b

update

f169c36

update

1147bf9

update

0dcad41

update

857494e

update

d715b9e

add test

c567216

add tests

b410884

update

c0e64ec

clean up

58f33e3

license

aef6b66

chunhtai added 2 commits November 10, 2025 09:41

update

54fe963

update

b201825

chunhtai force-pushed the issues/176425 branch from 48eb6ab to b201825 Compare November 10, 2025 17:41

chunhtai added 3 commits November 10, 2025 11:35

update

dc027a6

update

29b30b7

update

77ed1d2

chunhtai commented Nov 10, 2025

View reviewed changes

chunhtai requested a review from stuartmorgan-g November 10, 2025 20:15

[ci] Adds github action for creating batch release #10298

Are you sure you want to change the base?

[ci] Adds github action for creating batch release #10298

Uh oh!

Conversation

chunhtai commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-Review Checklist

Footnotes

Uh oh!

chunhtai commented Oct 27, 2025

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chunhtai commented Oct 24, 2025 •

edited

Loading