Skip to content

Commit f3a4b98

Browse files
authored
Update batch release doc to reflect latest workflow (flutter#186979)
<!-- Thanks for filing a pull request! Reviewers are typically assigned within a week of filing a request. To learn more about code review, see our documentation on Tree Hygiene: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md --> as title ## Pre-launch Checklist - [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [ ] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [ ] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [ ] I signed the [CLA]. - [ ] I listed at least one issue that this PR fixes in the description above. - [ ] I updated/added relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or this PR is [test-exempt]. - [ ] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [ ] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance. **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. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [AI contribution guidelines]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
1 parent 3266426 commit f3a4b98

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

‎docs/ecosystem/release/README.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ High-traffic packages can enable "Batch release" to group multiple commits into
3636

3737
To enable batch release for a package:
3838

39-
1. **Request a branch:** Ask a repo admin to create a protected `release-<package_name>` branch.
40-
2. **Submit a PR:** Create a PR with the following changes:
39+
1. **Submit a PR:** Create a PR with the following changes:
4140
* Add `ci_config.yaml` to the package root:
4241
```yaml
4342
release:
@@ -79,24 +78,24 @@ To enable batch release for a package:
7978
on:
8079
push:
8180
branches:
82-
- 'release-<package_name>'
81+
- 'release-<package_name>-*'
8382
```
8483
* Add a trigger to [sync_release_pr.yml](https://github.com/flutter/packages/blob/main/.github/workflows/sync_release_pr.yml):
8584
```yaml
8685
on:
8786
push:
8887
branches:
89-
- 'release-<package_name>'
88+
- 'release-<package_name>-*'
9089
```
91-
3. **Merge:** Merge the PR to finalize setup.
90+
2. **Merge:** Merge the PR to finalize setup.
9291

9392
### Workflow
9493

9594
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.
9695

9796
The release process runs automatically:
9897

99-
1. The cron job in `<package_name>_batch.yml` triggers a new release PR targeting the `release-<package_name>` branch.
98+
1. The cron job in `<package_name>_batch.yml` triggers a new release PR targeting the `release-<package_name>-<version>` branch.
10099
2. The PR aggregates all files in `pending_changes` to update `CHANGELOG.md` and `pubspec.yaml`.
101100
3. A package owner reviews and merges the PR.
102101
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.

0 commit comments

Comments
 (0)