Skip to content
This repository was archived by the owner on Nov 22, 2024. It is now read-only.

Commit 58b786f

Browse files
dgp1130alan-agius4
authored andcommitted
docs: update release changelog generation process.
This uses `yarn -s` to strip unnecessary wrapper text and uses `--type` instead of `--mode`, which is the required flag for `ng-dev`. The instructions now call out that two different release notes need to be generated in two different places. (cherry picked from commit dde41ec)
1 parent dce4446 commit 58b786f

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

docs/process/release.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,30 @@ git push upstream && git push upstream --tags
3636

3737
# Release Changelog
3838

39+
Release changelog needs to be included in two places, the GitHub release and in
40+
the
41+
[`CHANGELOG.md`](https://github.com/angular/universal/blob/master/CHANGELOG.md)
42+
file. These use different formats, so start with GitHub by running:
43+
44+
```sh
45+
yarn -s ng-dev release notes --type=github-release --from=<The git tag or ref to start the changelog entry from>
46+
```
47+
48+
- Go to the [`Releases` tab](https://github.com/angular/universal/releases) in
49+
the repository.
50+
- Click on the newly created tag.
51+
- Copy paste the output of the above command into the contents of the release.
52+
- Choose `This is a prerelase` checkbox for pre-release versions.
53+
54+
After creating a GitHub release, update the
55+
[`CHANGELOG.md`](https://github.com/angular/universal/blob/master/CHANGELOG.md)
56+
file by prepending it with changelog-formatted release notes (note
57+
`--type=changelog` which is _different_ from the GitHub release):
58+
3959
```sh
40-
yarn ng-dev release notes --from=<The git tag or ref to start the changelog entry from>
41-
yarn ng-dev release notes --mode=github-release --from=<The git tag or ref to start the changelog entry from>
60+
cat <(yarn -s ng-dev release notes --type=changelog --from=<The git tag or ref to start the changelog entry from>) \
61+
CHANGELOG.md > CHANGELOG.md
4262
```
4363

44-
- Go to the `Releases` tab in the repository
45-
- Click on the newly created tag (9.0.0-next.13 in this case)
46-
- Paste the contents of clipboard to the contents
47-
- Choose `This is a prerelase` checkbox for pre-release versions
64+
Then make a PR with the update targeting `master`, get a team member to review
65+
it, and merge when ready.

0 commit comments

Comments
 (0)