Skip to content

Commit 53684fe

Browse files
alexeaglehansl
authored andcommitted
docs: add some missing release bits (#11921)
1 parent 21d87e9 commit 53684fe

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/process/release.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,15 @@ Only the first 2 commits should be cherry picked to the patch branch, as the las
4444
## Shepparding
4545

4646
As commits are cherry-picked when PRs are merged, creating the release should be a matter of updating the version
47-
numbers. This can be done with the following command (for patch):
47+
numbers. This can be done with the following command.
48+
49+
See `scripts/release.ts` for the full list of release types, e.g. patch updates the third number per semver.
4850

4951
```bash
50-
devkit-admin release patch --force
52+
devkit-admin release patch --force # replace with minor-beta etc.
53+
git commit -a -m 'release: vXX'
54+
git tag 'vXX'
55+
git push upstream && git push upstream --tags
5156
```
5257

5358
### Publishing
@@ -68,13 +73,14 @@ devkit-admin publish --tag next
6873

6974
### Release Notes
7075

71-
Running the following command will output the release notes on stdout between v1.2.3 and 1.2.4:
76+
`devkit-admin changelog` takes `from` and `to` arguments which are any valid git ref.
77+
For example, running the following command will output the release notes on stdout between v1.2.3 and 1.2.4:
7278

7379
```bash
7480
devkit-admin changelog --from=v1.2.3 --to=v1.2.4
7581
```
7682

77-
Copy paste the output (you can use `| pbcopy` on MacOS) and create the release notes on github for the tag just
83+
Copy paste the output (you can use `| pbcopy` on MacOS or `|xclip` on Linux) and create the release notes on github for the tag just
7884
released. If you have an API token for GitHub you can create a draft automatically by using the `--githubToken` flag.
7985
You just have then to confirm the draft.
8086

0 commit comments

Comments
 (0)