From 854ade0cb9006ebbc603ac15fd01b22fe0e0f592 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Fri, 15 Jan 2021 12:27:35 +0000 Subject: [PATCH 1/3] doc: Add initial RELEASE.md --- RELEASE.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..379c3a49 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,42 @@ +# Releases + +## How to cut an individual release + +### Versioning strategy + +Releases of `cortex-jsonnet` are versioned to match the compatible version of Cortex. The release of `cortex-jsonnet`tagged `1.6.0` should match compatible with the release of Cortex tagged `1.6.0`. +A release of `cortex-jsonnet` should follow shortly after a release of Cortex. + +### Publish a release + +1. Create a branch for the new release. +2. Update the `CHANGELOG.md`. + - Add a new section for the new release so that "## master / unreleased" is blank and at the top. + - The new release section should say "## x.y.0 / YYYY-MM-DD". + - Ensure changelog entries for the new release are in this order: + * `[CHANGE]` + * `[FEATURE]` + * `[ENHANCEMENT]` + * `[BUGFIX]` +3. Update `cortex/images.libsonnet` to the released Cortex version. +4. Open a Pull Request for the your branch. +5. Once your Pull Request has been merged, checkout the merge commit and tag a release. Refer to [How to tag a release](#how-to-tag-a-release). +6. Build the `cortex-mixin.zip` for the release. + + ```console + $ make build-mixin + ``` +7. Add the `cortex-mixin.zip` and release change log to the GitHub release. + - Edit the release in GitHub by going to https://github.com/grafana/cortex-jsonnet/releases/edit/x.y.z + +### How to tag a release + +> **Note:** Unlike Cortex, release tags are not prefixed with a `v`. + +You can do the tagging on the commandline: + +```console +$ tag="x.y.z" +$ git tag -s v"${tag}" -m v"${tag}" +$ git push origin v"${tag}" +``` From 6d958c9e4b06466beb88c20543cc880e3e818474 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Fri, 15 Jan 2021 14:54:37 +0000 Subject: [PATCH 2/3] doc: Use full path to cortex-mixin.zip artifact Co-authored-by: Marco Pracucci --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 379c3a49..2c3405c4 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -26,7 +26,7 @@ A release of `cortex-jsonnet` should follow shortly after a release of Cortex. ```console $ make build-mixin ``` -7. Add the `cortex-mixin.zip` and release change log to the GitHub release. +7. Add the `cortex-mixin/cortex-mixin.zip` and release change log to the GitHub release. - Edit the release in GitHub by going to https://github.com/grafana/cortex-jsonnet/releases/edit/x.y.z ### How to tag a release From 69a26a392e33b5494eff2dc8d3fac166cd5d6e6b Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Fri, 15 Jan 2021 14:55:59 +0000 Subject: [PATCH 3/3] doc: fix tag commands Signed-off-by: Jack Baldry --- RELEASE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 2c3405c4..6f32f84c 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -37,6 +37,6 @@ You can do the tagging on the commandline: ```console $ tag="x.y.z" -$ git tag -s v"${tag}" -m v"${tag}" -$ git push origin v"${tag}" +$ git tag -s "${tag}" -m "${tag}" +$ git push origin "${tag}" ```