[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.

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

stuartmorgan-g · 2025-11-07T14:54:27Z

.github/workflows/batch_release_pr.yml

@@ -0,0 +1,33 @@
+name: "Creates Batch Release for go_router package"


Isn't the script generic?

stuartmorgan-g · 2025-11-07T14:56:34Z

.github/workflows/batch_release_pr.yml

+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "Batch release PR for ${{ github.event.client_payload.package }} package"
+          title: "Batch Release PR for ${{ github.event.client_payload.package }} package"
+          body: "This PR was created automatically to batch release the ${{ github.event.client_payload.package }} package."


Nit for all three of these: remove " package" from the end (and "the" from this last one), as it's clear in the context of flutter/packages that PRs are about packages.

stuartmorgan-g · 2025-11-07T14:57:06Z

.github/workflows/batch_release_pr.yml

+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "Batch release PR for ${{ github.event.client_payload.package }} package"
+          title: "Batch Release PR for ${{ github.event.client_payload.package }} package"
+          body: "This PR was created automatically to batch release the ${{ github.event.client_payload.package }} package."


Let's put `` around the package name in the body, as we frequently do that to make the package name especially clear.

stuartmorgan-g · 2025-11-07T14:57:55Z

.github/workflows/batch_release_pr.yml

+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "Batch release PR for ${{ github.event.client_payload.package }} package"


A commit isn't a PR, so the commit message shouldn't say "PR".

stuartmorgan-g · 2025-11-07T14:58:57Z

.github/workflows/batch_release_pr.yml

+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "Batch release PR for ${{ github.event.client_payload.package }} package"
+          title: "Batch Release PR for ${{ github.event.client_payload.package }} package"


This should follow repo convention: [${{ github.event.client_payload.package }}] Batch release.

(Ideally it would include the version, but getting that information across steps is probably more trouble than it's worth.)

stuartmorgan-g · 2025-11-07T15:38:13Z

script/tool/test/branch_for_batch_release_command_test.dart

+    package.directory.deleteSync(recursive: true);
+  });
+
+  Future<void> testReleaseBranch({


I find it almost impossible to understand what the tests are doing with a lot of scrolling back and forth because of this function. I would much, much rather this file be 50% longer (is it even that much?) if it means I can just read a test and trivially see what it is doing.

stuartmorgan-g · 2025-11-07T15:48:48Z

script/tool/lib/src/branch_for_batch_release_command.dart

+  final List<String> changelogs;
+}
+
+/// The type of version change for a release.


It should be very clearly documented that the order of these values is critical.

stuartmorgan-g · 2025-11-07T15:49:15Z

script/tool/test/branch_for_batch_release_command_test.dart

+        ],
+      );
+    });
+


I would expect explicit tests that given various combinations of different version update types, the resulting version is correct. It doesn't have to be every combination, but at least a sampling (and they should be explicit tests focusing on just that, without a lot of extraneous validation of the changelog output merging, so that it's obvious what the test is about).

Right now, it looks like someone could re-order VersionChange in various ways that would cause severely incorrect behavior, without any tests failing.

stuartmorgan-g · 2025-11-07T15:49:57Z

script/tool/test/branch_for_batch_release_command_test.dart

+    });
+  });
+
+  test('throw when github fails', () async {


I'm confused by this description; git rm doesn't interact with GitHub.

stuartmorgan-g · 2025-11-07T15:50:54Z

script/tool/test/branch_for_batch_release_command_test.dart

+    }
+
+    expect(error, isA<ToolExit>());
+  });


There are four different git commands with separate error codepaths; all of them should be tested.

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 added 17 commits November 7, 2025 15:23

Adds github action for creating batch release

865fbfc

adds github workflow for batch release

f3a573b

push change

0a78b10

update

18c57e3

update

e4a7c97

update

6d25533

update

09dce7b

update

b4b3150

update

4a49453

update

c082bfa

update

b0f2ff8

add test

088c381

add tests

87e8be0

update

1d10351

clean up

4e40b60

license

e486575

update

48eb6ab

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

		@@ -0,0 +1,33 @@
		name: "Creates Batch Release for go_router package"

[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!

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!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chunhtai commented Oct 24, 2025 •

edited

Loading