[ci] Update branch management for batch release (#11575)

based on go/batch-release-branch option 2

Needs to add flutter github bot to be able to bypass branch protection first

## Pre-Review Checklist

**Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). 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.

[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.

Author: chunhtai

.github/workflows/batch_release_pr.yml

@@ -4,64 +4,69 @@ on:
   repository_dispatch:
     types: [batch-release-pr]
 
+env:
+  HEAD_BRANCH_NAME: ${{ github.event.client_payload.package }}-${{ github.run_id }}-${{ github.run_attempt }}
+
 jobs:
   create_batch_release_branch:
     runs-on: ubuntu-latest
     permissions:
       contents: write # Grants write permission to create a branch.
-    env:
-      BRANCH_NAME: ${{ github.event.client_payload.package }}-${{ github.run_id }}-${{ github.run_attempt }}
     outputs:
-      branch_created: ${{ steps.check-branch-exists.outputs.exists }}
+      head_branch_created: ${{ steps.check-branch-exists.outputs.exists }}
+      release_branch: ${{ steps.create-branch.outputs.release_branch }} # e.g. release-go_router-17.2.2, returned by branches-for-batch-release tool.
+    env:
+      GITHUB_TOKEN: ${{ secrets.FLUTTERGITHUBBOT_TOKEN }}
     steps:
       - name: checkout repository
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+        with:
+          token: ${{ secrets.FLUTTERGITHUBBOT_TOKEN }}
       - name: "Install Flutter"
         uses: ./.github/workflows/internals/install_flutter
       - name: Set up tools
         run: dart pub get
         working-directory: ${{ github.workspace }}/script/tool
-      # This step is to create a branch for batch release
-      # A branch may not be created if there is nothing to release.
+      # This step is to create branches for a batch release
+      # Branches may not be created if there is nothing to release.
       # In that case, the workflow will exit and complete successfully.
       - name: create batch release branch
+        id: create-branch
         run: |
           git config --global user.name "flutteractionsbot"
           git config --global user.email "fluttergithubbot@gmail.com"
-          dart ./script/tool/lib/src/main.dart branch-for-batch-release --packages=${GITHUB_EVENT_CLIENT_PAYLOAD_PACKAGE} --branch=${BRANCH_NAME} --remote=origin
+          dart ./script/tool/lib/src/main.dart branches-for-batch-release --packages=${GITHUB_EVENT_CLIENT_PAYLOAD_PACKAGE} --branch=${HEAD_BRANCH_NAME} --remote=origin
         env:
           GITHUB_EVENT_CLIENT_PAYLOAD_PACKAGE: ${{ github.event.client_payload.package }}
       - name: Check if branch was created
         id: check-branch-exists
         run: |
-          if git show-ref --verify --quiet refs/heads/${BRANCH_NAME}; then
+          if git show-ref --verify --quiet refs/heads/${HEAD_BRANCH_NAME}; then
             echo "exists=true" >> $GITHUB_OUTPUT
           else
             echo "exists=false" >> $GITHUB_OUTPUT
           fi
 
   create_release_pr:
     needs: create_batch_release_branch
-    if: needs.create_batch_release_branch.outputs.branch_created == 'true'
+    if: needs.create_batch_release_branch.outputs.head_branch_created == 'true'
     runs-on: ubuntu-latest
     permissions:
       # The create-pull-request action needs both content and pull-requests permissions.
       pull-requests: write
       contents: write
     env:
-      BRANCH_NAME: ${{ github.event.client_payload.package }}-${{ github.run_id }}-${{ github.run_attempt }}
+      GITHUB_TOKEN: ${{ secrets.FLUTTERGITHUBBOT_TOKEN }}
     steps:
       - name: checkout repository
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
         with:
-          ref: ${{ env.BRANCH_NAME }}
+          ref: ${{ env.HEAD_BRANCH_NAME }}
       - name: Create batch release PR
-        env:
-          GITHUB_TOKEN: ${{ secrets.FLUTTERGITHUBBOT_TOKEN }}
         run: |
           gh pr create \
-            --base "release-${{ github.event.client_payload.package }}" \
-            --head "${{ env.BRANCH_NAME }}" \
+            --base "${{ needs.create_batch_release_branch.outputs.release_branch }}" \
+            --head "${{ env.HEAD_BRANCH_NAME }}" \
             --title "[${{ github.event.client_payload.package }}] Batch release" \
             --body "This PR was created automatically to batch release the \`${{ github.event.client_payload.package }}\`."
 

.github/workflows/release_from_branches.yml

@@ -2,7 +2,7 @@ name: Batch Release
 on:
   push:
     branches:
-      - 'release-go_router'
+      - 'release-go_router-*'
 permissions:
   # Release needs to push a tag back to the repo.
   contents: write

.github/workflows/sync_release_pr.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches:
       # As packages opt into batched releases, they need to be added here
-      - 'release-go_router'
+      - 'release-go_router-*'
 
 jobs:
   create_sync_pr:
@@ -35,10 +35,14 @@ jobs:
             exit 0
           fi
 
-          # 3. Create the PR directly
+          # 3. Extract release name without version for label
+          BRANCH_NAME="${{ github.ref_name }}"
+          RELEASE_NAME="${BRANCH_NAME%-*}"
+
+          # 4. Create the PR directly
           gh pr create \
             --base "main" \
             --head "${{ github.ref_name }}" \
             --title "Sync ${{ github.ref_name }} to main" \
             --body "This automated PR syncs the changes from the release branch ${{ github.ref_name }} back to the main branch." \
-            --label "override: post-${{ github.ref_name }}"
+            --label "override: post-${RELEASE_NAME}"

…rc/branch_for_batch_release_command.dart …/branches_for_batch_release_command.dartscript/tool/lib/src/branch_for_batch_release_command.dart renamed to script/tool/lib/src/branches_for_batch_release_command.dart script/tool/lib/src/branch_for_batch_release_command.dart renamed to script/tool/lib/src/branches_for_batch_release_command.dart

@@ -18,10 +18,10 @@ import 'common/repository_package.dart';
 const int _kExitPackageMalformed = 3;
 const int _kGitFailedToPush = 4;
 
-/// A command to create a remote branch with release changes for a single package.
-class BranchForBatchReleaseCommand extends PackageCommand {
-  /// Creates a new `branch-for-batch-release` command.
-  BranchForBatchReleaseCommand(
+/// A command to create remote branches with release changes for a single package.
+class BranchesForBatchReleaseCommand extends PackageCommand {
+  /// Creates a new `branches-for-batch-release` command.
+  BranchesForBatchReleaseCommand(
     super.packagesDir, {
     super.processRunner,
     super.platform,
@@ -42,10 +42,10 @@ class BranchForBatchReleaseCommand extends PackageCommand {
   }
 
   @override
-  final String name = 'branch-for-batch-release';
+  final String name = 'branches-for-batch-release';
 
   @override
-  final String description = 'Creates a release PR for a single package.';
+  final String description = 'Creates release branches for a single package.';
 
   @override
   Future<void> run() async {
@@ -97,7 +97,17 @@ class BranchForBatchReleaseCommand extends PackageCommand {
       return;
     }
 
-    await _generateCommitAndBranch(
+    final releaseBranchName =
+        'release-${package.directory.basename}-${releaseInfo.newVersion}';
+
+    await _createAndPushReleaseBranch(
+      git: repository,
+      package: package,
+      releaseBranchName: releaseBranchName,
+      remoteName: remoteName,
+    );
+
+    await _createHeadBranchAndCommit(
       git: repository,
       package: package,
       branchName: branchName,
@@ -145,7 +155,37 @@ class BranchForBatchReleaseCommand extends PackageCommand {
   /// remove the pending changelog files, stage the changes, and commit them.
   ///
   /// Throws a [ToolExit] if any of the steps fail.
-  Future<void> _generateCommitAndBranch({
+  Future<void> _createAndPushReleaseBranch({
+    required GitDir git,
+    required RepositoryPackage package,
+    required String releaseBranchName,
+    required String remoteName,
+  }) async {
+    print('  Creating release branch "$releaseBranchName"...');
+    final io.ProcessResult releaseBranchResult = await git.runCommand(<String>[
+      'branch',
+      releaseBranchName,
+    ]);
+    if (releaseBranchResult.exitCode != 0) {
+      printError(
+        'Failed to create release branch $releaseBranchName: ${releaseBranchResult.stderr}',
+      );
+      throw ToolExit(_kGitFailedToPush);
+    }
+
+    await _pushBranch(git, remoteName, releaseBranchName);
+
+    final String? githubOutput = platform.environment['GITHUB_OUTPUT'];
+    if (githubOutput != null && githubOutput.isNotEmpty) {
+      final File file = package.directory.fileSystem.file(githubOutput);
+      file.writeAsStringSync(
+        'release_branch=$releaseBranchName\n',
+        mode: io.FileMode.append,
+      );
+    }
+  }
+
+  Future<void> _createHeadBranchAndCommit({
     required GitDir git,
     required RepositoryPackage package,
     required String branchName,

script/tool/lib/src/main.dart

@@ -9,7 +9,7 @@ import 'package:file/file.dart';
 import 'package:file/local.dart';
 
 import 'analyze_command.dart';
-import 'branch_for_batch_release_command.dart';
+import 'branches_for_batch_release_command.dart';
 import 'build_examples_command.dart';
 import 'common/core.dart';
 import 'create_all_packages_app_command.dart';
@@ -92,7 +92,7 @@ void main(List<String> args) {
         ..addCommand(UpdateMinSdkCommand(packagesDir))
         ..addCommand(UpdateReleaseInfoCommand(packagesDir))
         ..addCommand(VersionCheckCommand(packagesDir))
-        ..addCommand(BranchForBatchReleaseCommand(packagesDir));
+        ..addCommand(BranchesForBatchReleaseCommand(packagesDir));
 
   commandRunner.run(args).catchError((Object e) {
     final toolExit = e as ToolExit;

script/tool/lib/src/publish_command.dart

@@ -233,7 +233,7 @@ class PublishCommand extends PackageLoopingCommand {
           // the opt-in flag and that the package name matches the branch suffix.
           // Example: branch "release-go_router" matches package "go_router".
           if (!isBatchReleasePackage ||
-              batchReleaseBranchName != 'release-$packageName') {
+              !batchReleaseBranchName.startsWith('release-$packageName-')) {
             continue;
           }
         }

script/tool/lib/src/repo_package_info_check_command.dart

@@ -2,8 +2,6 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import 'dart:io' as io;
-
 import 'package:file/file.dart';
 import 'package:yaml/yaml.dart';
 
@@ -274,13 +272,6 @@ class RepoPackageInfoCheckCommand extends PackageLoopingCommand {
       ),
     );
 
-    errors.addAll(
-      await _validateRemoteReleaseBranch(
-        packageName,
-        isBatchRelease: isBatchRelease,
-      ),
-    );
-
     if (isBatchRelease &&
         (package.parsePubspec().version?.isPreRelease ?? false)) {
       errors.add(
@@ -292,35 +283,6 @@ class RepoPackageInfoCheckCommand extends PackageLoopingCommand {
     return errors;
   }
 
-  Future<List<String>> _validateRemoteReleaseBranch(
-    String packageName, {
-    required bool isBatchRelease,
-  }) async {
-    final errors = <String>[];
-    // Verify release branch exists on remote flutter/packages if it is a batch release package.
-    final io.ProcessResult result = await (await gitDir).runCommand(<String>[
-      'ls-remote',
-      '--exit-code',
-      '--heads',
-      'origin',
-      'release-$packageName',
-    ], throwOnError: false);
-    final branchExists = result.exitCode == 0;
-    if (isBatchRelease && !branchExists) {
-      errors.add(
-        'Branch release-$packageName does not exist on remote flutter/packages\n'
-        'See https://github.com/flutter/flutter/blob/master/docs/ecosystem/release/README.md#batch-release',
-      );
-    }
-    // Allow branch to exist on remote flutter/packages for non-batch release packages.
-    // Otherwise, it will be hard to opt package out of batch release.
-    //
-    // Enforcing this will run into a deadlock where the ci in the PR to opts out of batch release
-    // will require removal of the release branch. but removing the release branch will immediately break
-    // the latest main.
-    return errors;
-  }
-
   List<String> _validateSpecificBatchWorkflow(
     String packageName, {
     required Directory workflowDir,
@@ -426,7 +388,7 @@ class RepoPackageInfoCheckCommand extends PackageLoopingCommand {
       if (push is YamlMap) {
         final branches = push['branches'] as YamlList?;
         if (branches is YamlList) {
-          if (branches.contains('release-$packageName')) {
+          if (branches.contains('release-$packageName-*')) {
             hasTrigger = true;
           }
         }
@@ -435,12 +397,12 @@ class RepoPackageInfoCheckCommand extends PackageLoopingCommand {
 
     if (isBatchRelease && !hasTrigger) {
       errors.add(
-        'Missing trigger for release-$packageName in .github/workflows/$workflowName\n'
+        'Missing trigger for release-$packageName-* in .github/workflows/$workflowName\n'
         'See https://github.com/flutter/flutter/blob/master/docs/ecosystem/release/README.md#batch-release',
       );
     } else if (!isBatchRelease && hasTrigger) {
       errors.add(
-        'Unexpected trigger for release-$packageName in .github/workflows/$workflowName\n',
+        'Unexpected trigger for release-$packageName-* in .github/workflows/$workflowName\n',
       );
     }
     return errors;