Skip to content

Commit 6263924

Browse files
dgp1130Keen Yee Liau
authored and
Keen Yee Liau
committed
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 1c916dc commit 6263924

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
@@ -112,6 +112,9 @@ As commits are cherry-picked when PRs are merged, creating the release should be
112112
```bash
113113
git commit -a -m 'release: vXX'
114114
git tag 'vXX'
115+
116+
# Make sure to run these commands together, as missing tags can cause CI
117+
# failures.
115118
git push upstream && git push upstream --tags
116119
```
117120

@@ -138,29 +141,31 @@ After closing the tab, you have successfully logged in, it is time to publish.
138141

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

141-
Check out the patch tag (e.g. `v6.7.8`), then run:
142-
```sh
143-
devkit-admin publish
144+
Check out the patch branch (e.g. `9.1.x`), then run:
145+
```bash
146+
yarn # Reload dependencies
147+
yarn admin publish
144148
```
145149

146-
Check out the minor tag (e.g. `v6.8.0-beta.0`), then run:
150+
If also publishing a prerelease, check out `master`, then run:
147151
```bash
148-
devkit-admin publish --tag next
152+
yarn # Reload dependencies
153+
yarn admin publish --tag next
149154
```
150155

151156
### Release Notes
152157

153-
`devkit-admin changelog` takes `from` and `to` arguments which are any valid git
158+
`yarn run -s admin changelog` takes `from` and `to` arguments which are any valid git
154159
ref.
155160

156161
For example, running the following command will output the release notes on
157162
stdout between v1.2.3 and 1.2.4:
158163

159164
```bash
160-
devkit-admin changelog --from=v1.2.3 --to=v1.2.4
165+
yarn run -s admin changelog --from=v1.2.3 --to=v1.2.4
161166
```
162167

163-
Copy the output (you can use `| pbcopy` on MacOS or `|xclip` on Linux) and
168+
Copy the output (you can use `| pbcopy` on MacOS or `| xclip` on Linux) and
164169
paste the release notes on [GitHub](https://github.com/angular/angular-cli/releases)
165170
for the tag just released.
166171

0 commit comments

Comments
 (0)