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

Commit 198eb9e

Browse files
committed
docs: update release docs to add additional things to update and some examples
Signed-off-by: Chris Privitere <[email protected]>
1 parent 2af548e commit 198eb9e

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

docs/RELEASE.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,20 @@ This is normally performed by our CI system. However, there are important steps
1010

1111
In order to cut a release, you must:
1212

13-
1. If this is a new major or minor version - but **not** just a patch change - update [metadata.yaml](../metadata.yaml) to add it, and map it to the correct cluster-api contract version
14-
1. Update [packet-ci-actions.yaml](../test/e2e/config/packet-ci-actions.yaml) and [packet-ci.yaml](../test/e2e/config/packet-ci.yaml) to use the new version number for the current and/or new contract version of the packet InfrastructureProvider.
15-
1. If this is a new major or minor version - but **not** just a patch chagne - update [packet-ci-actions.yaml](../test/e2e/config/packet-ci-actions.yaml) and [packet-ci.yaml](../test/e2e/config/packet-ci.yaml) to have a new "next" version number for the latest contract version of the packet InfrastructureProvider.
13+
1. Update [packet-ci-actions.yaml](../test/e2e/config/packet-ci-actions.yaml) and [packet-ci.yaml](../test/e2e/config/packet-ci.yaml) to use the new version number for the current and/or new contract version of the packet InfrastructureProvider. (ie. v0.9.1)
14+
1. If this is a new major or minor version - but **not** just a patch change:
15+
16+
- Update [metadata.yaml](../metadata.yaml) to add it, and map it to the correct cluster-api contract version
17+
18+
```yaml
19+
- major: 0
20+
minor: 10
21+
contract: v1beta1
22+
```
23+
24+
- Update [packet-ci-actions.yaml](../test/e2e/config/packet-ci-actions.yaml) and [packet-ci.yaml](../test/e2e/config/packet-ci.yaml) to have a new "next" version number for the latest contract version of the packet InfrastructureProvider (ie. v0.11.99).
25+
- Update clusterctl-settings.json to have the new "next" version number for the latest contract version of the packet InfrastructureProvider (ie. v0.11.99).
26+
1627
1. Commit the changes.
1728
1. Push out your branch, open a PR and merge the changes
1829
1. Wait for the Continuous Integration github action to finish running
@@ -21,7 +32,7 @@ In order to cut a release, you must:
2132

2233
## How A Release Happens
2334

24-
* GitHub Actions detects a new tag has been pushed
25-
* CI builds docker images for each supported architecture as well as a multi-arch manifest, and tags it with the semver tag of the release, e.g. `v0.4.0`
26-
* CI creates the release in `out/release`, the equivalent of `make release`
27-
* CI copies the artifacts in `out/release/*` to the github releases
35+
- GitHub Actions detects a new tag has been pushed
36+
- CI builds docker images for each supported architecture as well as a multi-arch manifest, and tags it with the semver tag of the release, e.g. `v0.4.0`
37+
- CI creates the release in `out/release`, the equivalent of `make release`
38+
- CI copies the artifacts in `out/release/*` to the github releases

0 commit comments

Comments
 (0)