Skip to content

Update batch release doc to reflect latest workflow #186979

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.

Sign up for GitHub

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
auto-submit merged 1 commit into from
May 26, 2026
+5 −6
Merged

Update batch release doc to reflect latest workflow #186979

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/ecosystem/release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ High-traffic packages can enable "Batch release" to group multiple commits into

To enable batch release for a package:

1. **Request a branch:** Ask a repo admin to create a protected `release-<package_name>` branch.
2. **Submit a PR:** Create a PR with the following changes:
1. **Submit a PR:** Create a PR with the following changes:
* Add `ci_config.yaml` to the package root:
```yaml
release:
Expand Down Expand Up @@ -79,24 +78,24 @@ To enable batch release for a package:
on:
push:
branches:
- 'release-<package_name>'
- 'release-<package_name>-*'
```
* Add a trigger to [sync_release_pr.yml](https://github.com/flutter/packages/blob/main/.github/workflows/sync_release_pr.yml):
```yaml
on:
push:
branches:
- 'release-<package_name>'
- 'release-<package_name>-*'
```
3. **Merge:** Merge the PR to finalize setup.
2. **Merge:** Merge the PR to finalize setup.

### Workflow

Once enabled, contributors **should not** modify `CHANGELOG.md` or `pubspec.yaml` directly. Instead, they must add a new file to the `pending_changes` directory for each PR.

The release process runs automatically:

1. The cron job in `<package_name>_batch.yml` triggers a new release PR targeting the `release-<package_name>` branch.
1. The cron job in `<package_name>_batch.yml` triggers a new release PR targeting the `release-<package_name>-<version>` branch.
2. The PR aggregates all files in `pending_changes` to update `CHANGELOG.md` and `pubspec.yaml`.
3. A package owner reviews and merges the PR.
4. Merging triggers [release_from_branches.yml](https://github.com/flutter/packages/blob/main/.github/workflows/release_from_branches.yml), which publishes the package to pub.dev.
Expand Down
Loading