README/OWNERS: update release creation section (#39)

* README: update release creation section Updates the README file section for how to manually create a release. Also adds a note that there's a periodic job that executes the release creation. Signed-off-by: Daniel Hiller <[email protected]> * README: remove sentence about making PR ready for review The GitHub action takes care of the PR and makes it ready for review, so you don't have to any more. Therefore we delete that sentence. Signed-off-by: Daniel Hiller <[email protected]> --------- Signed-off-by: Daniel Hiller <[email protected]>
kubevirt · Apr 19, 2024 · 9e8f99c · 9e8f99c
1 parent d5ce2fc
commit 9e8f99c
Showing 1 changed file with 28 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -80,17 +80,34 @@ After we have installed the virt plugin we can use it:
 
 ## Creating krew packages after a new KubeVirt release 
 
-Example: prepare a kubectl krew release for a new release
+**Note: a [prow job](https://github.com/kubevirt/project-infra/blob/cd56918c29690a1cda96d91a781b948f105c1dd6/github/ci/prow-deploy/files/jobs/kubevirt/kubectl-virt-plugin/kubectl-virt-plugin-periodics.yaml#L2) periodically executes the below script**
 
-### `./scripts/create-latest-release.sh`
+### Latest release
 
-Just execute `./scripts/create-latest-release.sh` from the base directory. The script will create packages, a yaml file, store them in a new release in GitHub repo and finally create a PR against the `krew-index` repo in draft mode.
+To manually prepare a kubectl krew release for a new release
+just execute `./scripts/create-latest-release.sh` from the base directory. The script will create packages and store them in a new release in GitHub repo.
 
-    $ ./scripts/create-latest-release.sh
-    Downloading binaries:
-    ...
-
-    Creating pull request:
-    ...
-
-After the script has finished successfully you should see a URL where you will find the created PR, which then just needs to be confirmed that it is reviewable.
+```bash
+$ ./scripts/create-latest-release.sh
+```
+
+Output will be
+```
+Downloading binaries:
+...
+
+Creating pull request:
+...
+```
+
+Creating the release will trigger [a GitHub action](.github/workflows/krew-release-bot.yaml) that then will create a PR against the [`krew-index`](https://github.com/kubernetes-sigs/krew-index) ([example](https://github.com/kubernetes-sigs/krew-index/pull/3677)).
+
+### Specific release
+
+Running `./scripts/create-release.sh` with a specific version will generate the release packages and create a release in GitHub.
+
+```bash
+./scripts/create-release.sh v1.2.0
+```
+
+The triggered GitHub actions will then create a PR as described above.