Skip to content

Commit 415cb8b

Browse files
committed
docs(*): add RELEASE.md
Signed-off-by: Vaughn Dice <vdice@akamai.com>
1 parent a6ecd1a commit 415cb8b

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

RELEASE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Runtime Class Manager release process
2+
3+
The vast majority of the release process is handled by GitHub workflows triggered by a tag push.
4+
See [release.yaml](./.github/workflows/release.yml) for the main workflow.
5+
6+
First, let's start by setting a `$TAG` environment variable to the version we'll release, so that we can reference it later.
7+
8+
For example, if the most recent release was `v0.1.0` and subsequent changes on
9+
the `main` branch include the usual collection of patches, fixes and features,
10+
we'd cut `v0.2.0`:
11+
12+
```console
13+
export TAG=v0.2.0 # CHANGEME
14+
```
15+
16+
Next, be sure that CI is green for the current commit on the `main` branch.
17+
18+
Then, to push the tag, do the following:
19+
20+
```console
21+
git checkout main
22+
git remote add upstream git@github.com:spinframework/runtime-class-manager
23+
git pull upstream main
24+
git tag --sign $TAG --message "Runtime Class Manager $TAG"
25+
git push upstream $TAG
26+
```
27+
28+
Observe that the [Release Workflow run for the tag](https://github.com/spinframework/runtime-class-manager/actions/workflows/release.yml) completed successfully.
29+
30+
Next, you'll need to update the documentation:
31+
32+
```console
33+
git clone git@github.com:spinframework/spinkube-docs
34+
cd spinkube-docs
35+
```
36+
37+
Change all references from the previous version to the new version.
38+
39+
Contribute those changes and open a PR.
40+
41+
As an optional step, you can run a set of smoke tests to ensure the latest release works as expected.
42+
43+
Finally, announce the new release on the #spinkube CNCF Slack channel.

0 commit comments

Comments
 (0)