From 601e594d75cc00a91853f8461a8fc4b3c1600e9f Mon Sep 17 00:00:00 2001 From: Ville Aikas <11279988+vaikas@users.noreply.github.com> Date: Fri, 2 Dec 2022 20:41:37 +0200 Subject: [PATCH] Update release instructions to use git tag from cli. (#488) * Use git tag from cli. Signed-off-by: Ville Aikas * add blurp about release notes. Signed-off-by: Ville Aikas Signed-off-by: Ville Aikas --- release.md | 58 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 48 insertions(+), 10 deletions(-) diff --git a/release.md b/release.md index e1534f75f..5eaa95c90 100644 --- a/release.md +++ b/release.md @@ -7,13 +7,51 @@ You should be part of the `scaffolding-codeowners` or `sigstore-oncall` groups, ## Steps -1. Visit -1. Click on the `Choose a tag` drop-down -1. For the tag name, use a new version number, for instance: v0.4.11 -1. Click on the `+ Create new tag: v0.4.11 on publish` button that appears. -1. For the release title, use the tag name: v0.4.11, -1. Click the `Generate release notes` button -1. Click the `Save Draft` button to trigger the `Release` action. -1. Monitor the [`Release` action](https://github.com/sigstore/scaffolding/actions/workflows/release.yaml), which generates the remaining release artifacts -1. Once the `Release` action has been completed successfully, find your draft release at the [releases page](https://github.com/sigstore/scaffolding/releases) -1. Click the green "Publish release" button +### Make sure your local branch is up-to-date from the upstream, for example: + +```shell +git pull upstream main --tags +``` + +### Verify the correct version you're about to tag: + +```shell +git tag +``` + +This will list all the tags, so the latest (at the time of this writing), was: +`v0.5.1` + +```shell +vaikas@villes-mbp scaffolding % git tag +v0.1-alpha +v0.1.1-alpha +v0.1.10-alpha +v0.1.11-alpha + +v0.4.9 +v0.5.0 +v0.5.1 +``` + +So, I will release `v0.5.2` + +### Tag the release with the new version number, for instance `v0.5.2` + +```shell +git tag -a v0.5.2 -m "v0.5.2" +``` + +### Push the tag + +```shell +git push upstream v0.5.2 +``` + +### Monitor the [`Release` action](https://github.com/sigstore/scaffolding/actions/workflows/release.yaml), which generates the remaining release artifacts + +### Once the `Release` action has been completed successfully, find your draft release at the [releases page](https://github.com/sigstore/scaffolding/releases) + +### Update the release notes by clicking on the `Generate release notes` button + +### Click the green "Publish release" button