Skip to content

Commit db9d81d

Browse files
committed
Add some notes on doing releases
Signed-off-by: James Sturtevant <jstur@microsoft.com>
1 parent d7dee0e commit db9d81d

2 files changed

Lines changed: 40 additions & 2 deletions

File tree

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
/dist
1+
/dist
2+
/manifest.yaml
3+
/kubectl-windows-debug-*.tar.gz

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,45 @@ kubectl windows-debug <node-name> --image <image-name>
3030
```
3131

3232
## Releasing
33+
34+
### Images
35+
36+
Modify the images in `images` folder and them to main branch.
37+
38+
The run:
39+
40+
```bash
41+
git checkout main
42+
git tag image-v<nextversion>
43+
git push --tags
44+
```
45+
46+
### plugin
47+
3348
Released with [krew release bot](https://github.com/rajatjindal/krew-release-bot).
3449

35-
## local testing
50+
51+
```bash
52+
git checkout main
53+
git tag v<nextversion>
54+
git push --tags
55+
```
56+
57+
The automation will create a github release and open a PR in https://github.com/kubernetes-sigs/krew-index. As long as only the version is changed, the PR will be automatically merged.
58+
59+
## test plugin locally
60+
61+
```bash
62+
# generate manifest
63+
docker run -v $(pwd)/.krew.yaml:/tmp/template-file.yaml rajatjindal/krew-release-bot:v0.0.43 krew-release-bot template --tag <github-tag> --template-file /tmp/template-file.yaml > manifest.yaml
64+
65+
66+
# install local package
67+
curl -LO <release-package-url>/kubectl-windows-debug-<tag0-version>.tar.gz
68+
kubectl krew install --manifest=manifest.yaml --archive=kubectl-windows-debug-latest.tar.gz
69+
```
70+
71+
See the following for details:
3672

3773
- https://krew.sigs.k8s.io/docs/developer-guide/testing-locally/
3874
- https://github.com/rajatjindal/krew-release-bot#testing-the-template-file

0 commit comments

Comments
 (0)