Skip to content

Commit d61fad3

Browse files
authored
Batch release directory correction (#189738)
The instructions gave the name of the directory as "pending_changes", but the correct name is "pending_changelogs". CI gave me an error when I tried the wrong name. See also go_router, which has the correct directory name: https://github.com/flutter/packages/tree/main/packages/go_router/pending_changelogs
1 parent 76bdc43 commit d61fad3

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎docs/ecosystem/release/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To enable batch release for a package:
4242
release:
4343
batch: true
4444
```
45-
* Create a `pending_changes` directory in the package root containing a `template.yaml` file:
45+
* Create a `pending_changelogs` directory in the package root containing a `template.yaml` file:
4646
```yaml
4747
# Use this file as a template to draft an unreleased changelog file.
4848
# Make a copy of this file in the same directory, give it an appropriate name, and fill in the details.
@@ -91,12 +91,12 @@ To enable batch release for a package:
9191

9292
### Workflow
9393

94-
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.
94+
Once enabled, contributors **should not** modify `CHANGELOG.md` or `pubspec.yaml` directly. Instead, they must add a new file to the `pending_changelogs` directory for each PR.
9595

9696
The release process runs automatically:
9797

9898
1. The cron job in `<package_name>_batch.yml` triggers a new release PR targeting the `release-<package_name>-<version>` branch.
99-
2. The PR aggregates all files in `pending_changes` to update `CHANGELOG.md` and `pubspec.yaml`.
99+
2. The PR aggregates all files in `pending_changelogs` to update `CHANGELOG.md` and `pubspec.yaml`.
100100
3. A package owner reviews and merges the PR.
101101
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.
102102
5. Simultaneously, [sync_release_pr.yml](https://github.com/flutter/packages/blob/main/.github/workflows/sync_release_pr.yml) creates a "sync PR" targeting the `main` branch.

0 commit comments

Comments
 (0)