Skip to content

Commit 14d3198

Browse files
dgp1130Keen Yee Liau
authored andcommitted
docs: add notes about various release foot-guns
This is a few different edits to make caretakers more aware of problems that can occur during a release. * Added a comment to reinforce that pushing tags needs to happen with the push of the release commit. Otherwise CI can fail `npm install` because the relevant tags are not set. * Changed to check out the publish branch rather than the tag because checking out a tag fails the subsequent `publish` command. * Added `yarn` before the `publish` command because dependencies may be out of date and cause errors.
1 parent 6ef9065 commit 14d3198

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

docs/process/release.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ As commits are cherry-picked when PRs are merged, creating the release should be
9898
```bash
9999
git commit -a -m 'release: vXX'
100100
git tag 'vXX'
101+
102+
# Make sure to run these commands together, as missing tags can cause CI
103+
# failures.
101104
git push upstream && git push upstream --tags
102105
```
103106

@@ -124,29 +127,31 @@ After closing the tab, you have successfully logged in, it is time to publish.
124127

125128
**It is a good idea to wait for CI to be green on the patch branch and tag before doing the release.**
126129

127-
Check out the patch tag (e.g. `v6.7.8`), then run:
128-
```sh
129-
devkit-admin publish
130+
Check out the patch branch (e.g. `9.1.x`), then run:
131+
```bash
132+
yarn # Reload dependencies
133+
yarn admin publish
130134
```
131135

132-
Check out the minor tag (e.g. `v6.8.0-beta.0`), then run:
136+
If also publishing a prerelease, check out `master`, then run:
133137
```bash
134-
devkit-admin publish --tag next
138+
yarn # Reload dependencies
139+
yarn admin publish --tag next
135140
```
136141

137142
### Release Notes
138143

139-
`devkit-admin changelog` takes `from` and `to` arguments which are any valid git
144+
`yarn run -s admin changelog` takes `from` and `to` arguments which are any valid git
140145
ref.
141146

142147
For example, running the following command will output the release notes on
143148
stdout between v1.2.3 and 1.2.4:
144149

145150
```bash
146-
devkit-admin changelog --from=v1.2.3 --to=v1.2.4
151+
yarn run -s admin changelog --from=v1.2.3 --to=v1.2.4
147152
```
148153

149-
Copy the output (you can use `| pbcopy` on MacOS or `|xclip` on Linux) and
154+
Copy the output (you can use `| pbcopy` on MacOS or `| xclip` on Linux) and
150155
paste the release notes on [GitHub](https://github.com/angular/angular-cli/releases)
151156
for the tag just released.
152157

0 commit comments

Comments
 (0)