Skip to content

Commit 9c0cfcd

Browse files
corneliusweigk8s-ci-robot
authored andcommitted
Update release instructions (#348)
* Update release instructions This was necessary after permission changes due to the repository migration to kubernetes-sigs. * Review comments and remove more outdated instructions * Add note to update the krew-index CI pipeline
1 parent c241a35 commit 9c0cfcd

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

docs/RELEASING_KREW.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Krew tags versions starting with `v`. Example: `v0.2.0-rc.1`.
2929
1. **Decide on a version number:** set it to `$TAG` variable:
3030

3131
```sh
32-
TAG=v0.2.0-rc.1 # <- change this
32+
TAG=v0.3.2-rc.1 # <- change this
3333
```
3434

3535
1. **Update installation instructions:** Version number is hardcoded in
@@ -39,9 +39,15 @@ Krew tags versions starting with `v`. Example: `v0.2.0-rc.1`.
3939

4040
git commit -am "Release ${TAG:?TAG required}"
4141

42+
1. **Push PR and merge changes**: The repository hooks forbid direct pushes to
43+
master, so the changes from the previous step need to be pushed and merged
44+
as a regular PR.
45+
4246
1. **Tag the release:**
4347

4448
```sh
49+
git fetch origin
50+
git reset --hard origin/master # when the previous merge is done
4551
release_notes="$(TAG=$TAG hack/make-release-notes.sh)"
4652
git tag -a "${TAG:?TAG required}" -m "${release_notes}"
4753
```
@@ -52,19 +58,22 @@ Krew tags versions starting with `v`. Example: `v0.2.0-rc.1`.
5258

5359
1. **Push the tag:**
5460

55-
git push --follow-tags
56-
57-
Due to branch restrictions on GitHub preventing pushing to a branch
58-
directly, this command may require `-f`.
61+
git push --tags
5962

6063
1. **Verify on Releases tab on GitHub**
6164

62-
1. **Make the new version available on krew index:** Copy the `krew.yaml` from
63-
the release artifacts and make a pull request to
65+
1. **Make the new version available on krew index:** Get the latest `krew.yaml` from
66+
67+
curl -LO https://github.com/kubernetes-sigs/krew/releases/download/v0.3.2-rc.1/krew.yaml
68+
69+
and make a pull request to
6470
[krew-index](https://github.com/kubernetes-sigs/krew-index/) repository.
6571
This will make the plugin available to upgrade for users using older versions
6672
of krew.
6773

74+
1. **Update krew-index CI**: For validating manifests, the CI should use the latest version
75+
(see `.travis.yml` in `krew-index` the repository).
76+
6877
## Release artifacts
6978

7079
When a tag is pushed to the repository, Travis CI will make a release on GitHub

0 commit comments

Comments
 (0)