Skip to content

Commit e433647

Browse files
authored
Merge pull request prometheus#16416 from prometheus/beorn7/doc
doc: Move library release tagging to a separate section
2 parents b4526c0 + c018383 commit e433647

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

RELEASE.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -135,19 +135,7 @@ git tag -s "${tag}" -m "${tag}"
135135
git push origin "${tag}"
136136
```
137137

138-
Go modules versioning requires strict use of semver. Because we do not commit to
139-
avoid code-level breaking changes for the libraries between minor releases of
140-
the Prometheus server, we use major version zero releases for the libraries.
141-
142-
Tag the new library release via the following commands:
143-
144-
```bash
145-
tag="v$(./scripts/get_module_version.sh)"
146-
git tag -s "${tag}" -m "${tag}"
147-
git push origin "${tag}"
148-
```
149-
150-
Optionally, you can use this handy `.gitconfig` alias.
138+
Alternatively, you can use this handy `.gitconfig` alias.
151139

152140
```ini
153141
[alias]
@@ -163,7 +151,22 @@ Once a tag is created, the release process through Github Actions will be trigge
163151
Finally, wait for the build step for the tag to finish. The point here is to wait for tarballs to be uploaded to the Github release and the container images to be pushed to the Docker Hub and Quay.io. Once that has happened, click _Publish release_, which will make the release publicly visible and create a GitHub notification.
164152
**Note:** for a release candidate version ensure the _This is a pre-release_ box is checked when drafting the release in the Github UI. The CI job should take care of this but it's a good idea to double check before clicking _Publish release_.`
165153

166-
### 3. Wrapping up
154+
### 3. Tag the library release
155+
156+
Go modules versioning requires strict use of semver. Because we do not commit to
157+
avoid code-level breaking changes for the libraries between minor releases of
158+
the Prometheus server, we use major version zero releases for the libraries.
159+
160+
Tagging the new library release works similar to the normal release tagging,
161+
but without the subsequent build and publish steps. Use the following commands:
162+
163+
```bash
164+
tag="v$(./scripts/get_module_version.sh)"
165+
git tag -s "${tag}" -m "${tag}"
166+
git push origin "${tag}"
167+
```
168+
169+
### 4. Wrapping up
167170

168171
For release candidate versions (`v2.16.0-rc.0`), run the benchmark for 3 days using the `/prombench vX.Y.Z` command, `vX.Y.Z` being the latest stable patch release's tag of the previous minor release series, such as `v2.15.2`.
169172

0 commit comments

Comments
 (0)