Skip to content

Commit 5187741

Browse files
authored
release notes (#415)
1 parent e7d4b91 commit 5187741

1 file changed

Lines changed: 20 additions & 6 deletions

File tree

docs/content/developers/publishing-a-release.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,34 +29,48 @@ kube-bind has 3 go modules, and a unique tag is needed for each module every tim
2929

3030
```shell
3131
REF=upstream/main
32-
TAG=v0.5.1
32+
TAG=v0.6.0
3333
git tag --sign --message "$TAG" "$TAG" "$REF"
3434
```
3535

3636
3. Tag the `sdk` module, following the same logic as above for `REF` and `TAG`
3737

3838
```shell
3939
REF=upstream/main
40-
TAG=v0.5.1
40+
TAG=v0.6.0
4141
git tag --sign --message "sdk/$TAG" "sdk/$TAG" "$REF"
4242
```
4343

4444
4. Tag the `cli` module, following the same logic as above for `REF` and `TAG`
4545

4646
```shell
4747
REF=upstream/main
48-
TAG=v0.5.1
48+
TAG=v0.6.0
4949
git tag --sign --message "cli/$TAG" "cli/$TAG" "$REF"
5050
```
5151

5252
### Push the Tags
5353

5454
```shell
5555
REMOTE=upstream
56-
TAG=v0.5.1
56+
TAG=v0.6.0
5757
git push "$REMOTE" "$TAG" "sdk/$TAG" "cli/$TAG"
5858
```
5959

60+
### Create a Release Branch
61+
62+
Set `REMOTE`, `REF`, and `VERSION` as appropriate.
63+
64+
```shell
65+
REMOTE=upstream
66+
REF="$REMOTE/main"
67+
VERSION=0.6 # e.g. 1.2
68+
git checkout -b "release-$VERSION" "$REF"
69+
git push "$REMOTE" "release-$VERSION"
70+
```
71+
72+
Once you tag and push the new release branch, don't forget to run the documentation deployment as described in [Trigger Documentation Deployment](#trigger-documentation-deployment).
73+
6074
## If it's a New Minor Version
6175

6276
If this is the first release of a new minor version (e.g. the last release was v0.7.x, and you are releasing the first
@@ -79,8 +93,8 @@ To use `release-notes` you will need to generate a GitHub API token (Settings ->
7993
Then, run the `release-notes` tool (set `PREV_VERSION` to the version released before the one you have just released).
8094
8195
```shell
82-
TAG=v0.5.0
83-
PREV_TAG=v0.4.8
96+
TAG=v0.6.0
97+
PREV_TAG=v0.5.1
8498
release-notes \
8599
--required-author='' \
86100
--org kube-bind \

0 commit comments

Comments
 (0)