Skip to content

Commit a7c1ffc

Browse files
authored
Merge pull request #281 from ember-cli/update-release-docs
Update RELEASE.md
2 parents b7e3b05 + a78fffe commit a7c1ffc

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

RELEASE.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,21 +46,24 @@ You can use [this saved search](https://github.com/ember-cli/ember-app-blueprint
4646
- **make sure to not update the CHANGELOG.md file** so as not to include the beta or alpha changelogs in the next release
4747
- make sure to not update the version in the package.json during this step, this will be release-plan's job
4848
- make sure to not add the `release-plan` config section to the package.json during this step. We are releasing a real release so we don't want to configure release-plan to do a pre-release.
49+
- commit this merge
4950
- Update blueprint dependencies to latest
5051

5152
```
52-
pnpm dlx update-blueprint-deps --filter 'ember-source' --tag latest files/package.json
53+
pnpm dlx update-blueprint-deps --filter 'ember-source' --tag latest package.json files/package.json
5354
pnpm dlx update-blueprint-deps --filter '.*' package.json files/package.json
5455
```
5556

5657
- commit this update `git commit -am "update blueprint dependencies to latest"`
57-
- push and open a PR targeting `release` with a PR title like `Update all dependencies for 6.4 release`
58-
- mark this PR as an `enhancement` if it is a minor release
58+
- push and open a PR targeting `release` with a PR title like `Promote Beta and update all dependencies for 6.4 release`
59+
- mark this PR as an `enhancement` if it is a minor release, or `breaking` if it is a major release
5960
- check that everything is ok (i.e. that CI has run correctly and that you have the changes you expect)
6061
- merge branch
6162
- check that the `Prepare Release` PR has been correctly opened by `release-plan`
63+
- review the included PRs in the changelog and add `ignore` to things that shouldn't be there
64+
- after adding any `ignore` labels, wait for the `Prepare Release` PR to be updated
6265
- Merge the `Prepare Release` branch when you are ready to release
63-
- Check the `Release Stable` GitHub action to make sure the release succeeded
66+
- Check the `Publish` GitHub action to make sure the release succeeded
6467

6568
### Release ember-cli and update that dependency
6669

@@ -108,9 +111,10 @@ You can use [this saved search](https://github.com/ember-cli/ember-app-blueprint
108111
pnpm dlx update-blueprint-deps --filter '.*' package.json files/package.json
109112
```
110113

114+
- run `pnpm install` to install any updated packages
111115
- commit this update `git commit -am "update blueprint dependencies to beta"`
112116
- push and open a PR targeting `beta` with a PR title like `Prepare 6.5-beta`
113-
- mark this PR as an `enchancement` if the next beta is a minor release
117+
- mark this PR as an `enchancement`
114118
- check that everything is ok i.e. CI passes
115119
- merge the `merge-release` branch into `beta` in GitHub
116120
- check that the `Prepare Beta Release` PR has been correctly opened by `release-plan`
@@ -141,7 +145,7 @@ You can use [this saved search](https://github.com/ember-cli/ember-app-blueprint
141145

142146
- commit this update `git commit -am "update blueprint dependencies to alpha"`
143147
- push and open a PR targeting `main` with a PR title like `Prepare 6.6-alpha`
144-
- mark this PR as an `enchancement` if the next alpha is a minor release
148+
- mark this PR as an `enchancement`
145149
- check that everything is ok i.e. CI passes
146150
- merge the `merge-beta` branch into `main` in GitHub
147151
- check that the `Prepare Alpha Release` PR has been correctly opened by `release-plan`
@@ -183,3 +187,6 @@ If you want to change the content of the Changelog then you should update the PR
183187
## Patch Releases
184188

185189
Now that we're using release-plan for all releases, patch releases have become super easy! Every time you merge a PR to any branch that is being released with `release-plan` a new `Prepare Release` PR will be created. When you merge this `Prepare Release` branch it will automatically release the new Patch version.
190+
191+
> [!NOTE]
192+
> If you merge a patch into any branch other than main, you **must** merge all branches forward i.e. release -> beta -> main so that the change gets applied to all branches correctly. For example: if you update a dependency on the `release` branch, you should then create a branch from `beta` and merge `release` into that branch and open a PR with this change to target `beta`. The same should happen from `beta` to `main`.

0 commit comments

Comments
 (0)