From ca1222835ff0b30ce3aca746668d08de4c53d150 Mon Sep 17 00:00:00 2001 From: Rajat Jindal Date: Sat, 18 Jan 2020 18:13:01 +0530 Subject: [PATCH 1/5] add documentation about automating release using krew-release-bot --- docs/DEVELOPER_GUIDE.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md index f55c4888..a9250510 100644 --- a/docs/DEVELOPER_GUIDE.md +++ b/docs/DEVELOPER_GUIDE.md @@ -333,5 +333,12 @@ Ideally, the `version` specified should match the release tag of the plugin. This helps users and maintainers to easily identify which version of the plugin they have installed. +### Automating the releasing of new version + +You can use `github actions` to automate the release process. e.g. You can use +`go-releaser` (or equivalent for other languages) for creation of new release and +[`krew-release-bot`](https://github.com/rajatjindal/krew-release-bot) to bump the +version in `krew-index` repo. Refer to the [documentation here](https://github.com/rajatjindal/krew-release-bot#basic-setup) for an example. + [index]: https://github.com/kubernetes-sigs/krew-index [plugins]: https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/ From bfc37cc709f85d4a0e4454b4fd59dde37e963d4c Mon Sep 17 00:00:00 2001 From: Rajat Jindal Date: Sun, 19 Jan 2020 07:44:57 +0530 Subject: [PATCH 2/5] update doc --- docs/DEVELOPER_GUIDE.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md index a9250510..c0e6ea76 100644 --- a/docs/DEVELOPER_GUIDE.md +++ b/docs/DEVELOPER_GUIDE.md @@ -335,10 +335,8 @@ they have installed. ### Automating the releasing of new version -You can use `github actions` to automate the release process. e.g. You can use -`go-releaser` (or equivalent for other languages) for creation of new release and -[`krew-release-bot`](https://github.com/rajatjindal/krew-release-bot) to bump the -version in `krew-index` repo. Refer to the [documentation here](https://github.com/rajatjindal/krew-release-bot#basic-setup) for an example. +You can use github actions to publish new release of your krew plugin. `krew-release-bot` +is a github action to automatically bump the version in `krew-index` repo. Refer to the [documentation here](https://github.com/rajatjindal/krew-release-bot) for details. [index]: https://github.com/kubernetes-sigs/krew-index [plugins]: https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/ From a24dbba7792ae480582071291af4f00f6083dd94 Mon Sep 17 00:00:00 2001 From: Rajat Jindal Date: Sun, 19 Jan 2020 08:28:24 +0530 Subject: [PATCH 3/5] capitalize and wrap lines --- docs/DEVELOPER_GUIDE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md index c0e6ea76..d86f98d6 100644 --- a/docs/DEVELOPER_GUIDE.md +++ b/docs/DEVELOPER_GUIDE.md @@ -335,8 +335,10 @@ they have installed. ### Automating the releasing of new version -You can use github actions to publish new release of your krew plugin. `krew-release-bot` -is a github action to automatically bump the version in `krew-index` repo. Refer to the [documentation here](https://github.com/rajatjindal/krew-release-bot) for details. +You can use Github Actions to publish new release of your Krew plugin. +`krew-release-bot` is a github action to automatically bump the version in +`krew-index` repo. +Refer to the [documentation here](https://github.com/rajatjindal/krew-release-bot) for details. [index]: https://github.com/kubernetes-sigs/krew-index [plugins]: https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/ From 53c496b77269ee3af46ecf9a65c0d6328caed708 Mon Sep 17 00:00:00 2001 From: Rajat Jindal Date: Mon, 20 Jan 2020 08:24:23 +0530 Subject: [PATCH 4/5] update doc --- docs/DEVELOPER_GUIDE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md index d86f98d6..50b029e7 100644 --- a/docs/DEVELOPER_GUIDE.md +++ b/docs/DEVELOPER_GUIDE.md @@ -333,12 +333,12 @@ Ideally, the `version` specified should match the release tag of the plugin. This helps users and maintainers to easily identify which version of the plugin they have installed. -### Automating the releasing of new version +### Automate releasing new versions on krew-index You can use Github Actions to publish new release of your Krew plugin. -`krew-release-bot` is a github action to automatically bump the version in +`krew-release-bot` is a Github Action to automatically bump the version in `krew-index` repo. -Refer to the [documentation here](https://github.com/rajatjindal/krew-release-bot) for details. +Refer to the [krew-release-bot](https://github.com/rajatjindal/krew-release-bot) for details. [index]: https://github.com/kubernetes-sigs/krew-index [plugins]: https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/ From ef5b2ea1eedcc0f58028bbe3856923e292daad55 Mon Sep 17 00:00:00 2001 From: Rajat Jindal Date: Sat, 25 Jan 2020 10:45:06 +0530 Subject: [PATCH 5/5] fix doc wording --- docs/DEVELOPER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md index 50b029e7..cee3fb50 100644 --- a/docs/DEVELOPER_GUIDE.md +++ b/docs/DEVELOPER_GUIDE.md @@ -338,7 +338,7 @@ they have installed. You can use Github Actions to publish new release of your Krew plugin. `krew-release-bot` is a Github Action to automatically bump the version in `krew-index` repo. -Refer to the [krew-release-bot](https://github.com/rajatjindal/krew-release-bot) for details. +Refer to the [krew-release-bot](https://github.com/rajatjindal/krew-release-bot) documentation for details. [index]: https://github.com/kubernetes-sigs/krew-index [plugins]: https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/