Skip to content

Commit

Permalink
Add pre-release steps and docs (#102)
Browse files Browse the repository at this point in the history
  • Loading branch information
bschimke95 authored Jan 31, 2025
1 parent 270ac09 commit e61162f
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 4 deletions.
13 changes: 13 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# How to cut a CAPI provider release

For `minor` releases you need to do the following pre-release steps:

1. Add the new release with the corresponding CAPI contract to [the metadata file](../metadata.yaml)
2. Update the integration test files with the latest minor version:
* https://github.com/canonical/cluster-api-k8s/blob/91e4fe70dfb7aaa357396d62c84f0d60de45595f/test/e2e/config/ck8s-docker.yaml#66
* https://github.com/canonical/cluster-api-k8s/blob/91e4fe70dfb7aaa357396d62c84f0d60de45595f/test/e2e/config/ck8s-docker.yaml#77
* https://github.com/canonical/cluster-api-k8s/blob/91e4fe70dfb7aaa357396d62c84f0d60de45595f/test/e2e/config/ck8s-aws.yaml#L64
* https://github.com/canonical/cluster-api-k8s/blob/91e4fe70dfb7aaa357396d62c84f0d60de45595f/test/e2e/config/ck8s-aws.yaml#L74

Now, for `minor` and `patch` releases alike, you only need to create a new tag `vX.Y.ZZ` or `vX.Y.ZZ-rcABC` for release candidates.
The [Github workflow](https://github.com/canonical/cluster-api-k8s/blob/main/.github/workflows/release.yaml#L7) will then automatically create the release packages and add a new release to Github.
3 changes: 3 additions & 0 deletions metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ releaseSeries:
- major: 0
minor: 2
contract: v1beta1
- major: 0
minor: 3
contract: v1beta1
4 changes: 2 additions & 2 deletions test/e2e/config/ck8s-aws.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ providers:
# ${ProjectRoot}/metadata.yaml to init the management cluster
# this version should be updated when ${ProjectRoot}/metadata.yaml
# is modified
- name: v0.2.99 # next; use manifest from source files
- name: v0.3.99 # next; use manifest from source files
value: "../../../bootstrap/config/default"
replacements:
- old: "ghcr.io/canonical/cluster-api-k8s/bootstrap-controller:latest"
Expand All @@ -71,7 +71,7 @@ providers:
- name: ck8s
type: ControlPlaneProvider
versions:
- name: v0.2.99 # next; use manifest from source files
- name: v0.3.99 # next; use manifest from source files
value: "../../../controlplane/config/default"
replacements:
- old: "ghcr.io/canonical/cluster-api-k8s/controlplane-controller:latest"
Expand Down
4 changes: 2 additions & 2 deletions test/e2e/config/ck8s-docker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ providers:
# ${ProjectRoot}/metadata.yaml to init the management cluster
# this version should be updated when ${ProjectRoot}/metadata.yaml
# is modified
- name: v0.2.99 # next; use manifest from source files
- name: v0.3.99 # next; use manifest from source files
value: "../../../bootstrap/config/default"
replacements:
- old: "ghcr.io/canonical/cluster-api-k8s/bootstrap-controller:latest"
Expand All @@ -74,7 +74,7 @@ providers:
- name: ck8s
type: ControlPlaneProvider
versions:
- name: v0.2.99 # next; use manifest from source files
- name: v0.3.99 # next; use manifest from source files
value: "../../../controlplane/config/default"
replacements:
- old: "ghcr.io/canonical/cluster-api-k8s/controlplane-controller:latest"
Expand Down

0 comments on commit e61162f

Please sign in to comment.