Skip to content
This repository was archived by the owner on Apr 28, 2025. It is now read-only.

Commit c0923db

Browse files
authored
Merge pull request #248 from grafana/jdb/add-release.md
doc: Add initial RELEASE.md
2 parents 0917b3c + 69a26a3 commit c0923db

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

RELEASE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Releases
2+
3+
## How to cut an individual release
4+
5+
### Versioning strategy
6+
7+
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`.
8+
A release of `cortex-jsonnet` should follow shortly after a release of Cortex.
9+
10+
### Publish a release
11+
12+
1. Create a branch for the new release.
13+
2. Update the `CHANGELOG.md`.
14+
- Add a new section for the new release so that "## master / unreleased" is blank and at the top.
15+
- The new release section should say "## x.y.0 / YYYY-MM-DD".
16+
- Ensure changelog entries for the new release are in this order:
17+
* `[CHANGE]`
18+
* `[FEATURE]`
19+
* `[ENHANCEMENT]`
20+
* `[BUGFIX]`
21+
3. Update `cortex/images.libsonnet` to the released Cortex version.
22+
4. Open a Pull Request for the your branch.
23+
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).
24+
6. Build the `cortex-mixin.zip` for the release.
25+
26+
```console
27+
$ make build-mixin
28+
```
29+
7. Add the `cortex-mixin/cortex-mixin.zip` and release change log to the GitHub release.
30+
- Edit the release in GitHub by going to https://github.com/grafana/cortex-jsonnet/releases/edit/x.y.z
31+
32+
### How to tag a release
33+
34+
> **Note:** Unlike Cortex, release tags are not prefixed with a `v`.
35+
36+
You can do the tagging on the commandline:
37+
38+
```console
39+
$ tag="x.y.z"
40+
$ git tag -s "${tag}" -m "${tag}"
41+
$ git push origin "${tag}"
42+
```

0 commit comments

Comments
 (0)