Skip to content

Commit 8cc0260

Browse files
Create release documentation (#373)
Signed-off-by: Hayden B <[email protected]>
1 parent ca27676 commit 8cc0260

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+
# Releasing rekor-tiles
2+
3+
## Publishing updated binary and container
4+
5+
This guide assumes that `upstream` references github.com/sigstore/rekor-tiles.
6+
7+
Create and push a new tag. Note that you can't create a tag without creating a release in the GitHub UI, so you'll need to do this locally.
8+
9+
```
10+
git pull upstream main
11+
export RELEASE_TAG=v1.2.3 # Specify version
12+
git tag -s ${RELEASE_TAG} -m "${RELEASE_TAG}"
13+
git push upstream ${RELEASE_TAG}
14+
```
15+
16+
After the tag is pushed, two workflows will kick off:
17+
18+
* [Create release](https://github.com/sigstore/rekor-tiles/actions/workflows/release.yml)
19+
* [Create and publish Docker image](https://github.com/sigstore/rekor-tiles/actions/workflows/build_container.yml)
20+
21+
Once "Create release" finishes, go to [Releases](https://github.com/sigstore/rekor-tiles/releases), select
22+
the latest draft release, and publish it. If the release is pre-1.0, select "Set as a pre-release" before publishing.
23+
24+
## Updating the infrastructure
25+
26+
Update the [Helm chart](https://github.com/sigstore/helm-charts/tree/main/charts/rekor-tiles) to the latest version.
27+
Follow [this example](https://github.com/sigstore/helm-charts/pull/989/).
28+
29+
Get the container digest:
30+
31+
```
32+
crane digest ghcr.io/sigstore/rekor-tiles:v1.2.3 # Specify version
33+
```
34+
35+
Update `charts/rekor-tiles/values.yaml` with the new container version and digest.
36+
37+
Update `charts/rekor-tiles/Chart.yaml`, bumping `version`, `appVersion`, and the image reference.
38+
39+
Run `helm-docs -g charts/rekor-tiles` to update the README.
40+
41+
Create a PR and wait for an oncall engineer to approve and merge. An oncall engineer also needs to
42+
update the chart version on the PGI repo.

0 commit comments

Comments
 (0)