Skip to content

Commit 221d8ba

Browse files
committed
update releasing process doc
Update prior art, add IrSO parts, remove TODO etc. Mariadb tagging is deprecated and will apply the CAPM3 v1.11 and not releases after that. Signed-off-by: Tuomo Tanskanen <[email protected]>
1 parent b6200a9 commit 221d8ba

File tree

2 files changed

+26
-32
lines changed

2 files changed

+26
-32
lines changed

.cspell-config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@
109109
"iptables",
110110
"iPXE",
111111
"ironicendpoint",
112+
"irso",
112113
"iso",
113114
"Jern",
114115
"js",

processes/releasing.md

Lines changed: 25 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,31 @@
33
This document details the high-level process of creating a Metal3 release, and
44
the post-release actions required to add new release branches to the CI.
55

6-
Note the [TODO](#releasing-process-todo) section in the end.
7-
86
## Process
97

108
High-level release process for a major/minor release. For patch releases, only
119
release the relevant versions.
1210

13-
**NOTE**: Ironic-image (via upstream Ironic) has different release cadence as
14-
Metal3 repos. It is not always possible to release them synced.
11+
**NOTE**: [Ironic-image](https://github.com/metal3-io/ironic-image) (via
12+
upstream Ironic) and
13+
[IrSO](https://github.com/metal3-io/ironic-standalone-operator) (linked to
14+
Ironic-image releases) have different release cadence as CAPM3, BMO and IPAM
15+
repos.
1516

16-
1. [Release ironic-image](https://github.com/metal3-io/ironic-image/blob/main/docs/releasing.md)
17+
1. [Release Ironic-image](https://github.com/metal3-io/ironic-image/blob/main/docs/releasing.md)
18+
1. [Release IrSO](https://github.com/metal3-io/ironic-standalone-operator/blob/main/docs/releasing.md)
1719
1. [Release IPAM](https://github.com/metal3-io/ip-address-manager/blob/main/docs/releasing.md)
1820
1. [Release BMO](https://github.com/metal3-io/baremetal-operator/blob/main/docs/releasing.md)
1921
1. [Release CAPM3](https://github.com/metal3-io/cluster-api-provider-metal3/blob/main/docs/releasing.md)
20-
1. [Tag Mariadb image](#tag-mariadb-image)
2122
1. [Update Metal3 dev-env and CI to support new releases](#update-metal3-dev-env-and-ci-to-support-new-releases)
2223

2324
**NOTE**: Always follow release documentation from the respective main branch.
2425
Release documentation in release branches may be outdated.
2526

2627
## Tag Mariadb image
2728

29+
**NOTE**: This step is deprecated and is applied only up to CAPM3 v1.11.x tags.
30+
2831
After releasing `v1.x.y` version of CAPM3, create an annotated tag with `capm3-`
2932
prefix + release version in
3033
[mariadb-image](https://github.com/metal3-io/mariadb-image) Github repository.
@@ -85,21 +88,27 @@ for periodics and PR jobs.
8588
We also need to change project-infra keywords for required tests for some of
8689
the repositories.
8790

88-
[Prior art](https://github.com/metal3-io/project-infra/pull/496)
91+
Prior art - jobs:
92+
93+
- [BMO](https://github.com/metal3-io/project-infra/pull/1000)
94+
- [IPAM](https://github.com/metal3-io/project-infra/pull/998)
95+
- [CAPM3](https://github.com/metal3-io/project-infra/pull/999)
96+
- [IrSO](https://github.com/metal3-io/project-infra/pull/1034)
97+
- [Other jobs and milestones](https://github.com/metal3-io/project-infra/pull/1002)
8998

9099
### Configure Metal3 dev-env to support new branches
91100

92101
Metal3-dev-env needs to be modified to support new release branches and
93102
tags with supported combination of component versions for testing.
94103

95-
[Prior art](https://github.com/metal3-io/metal3-dev-env/pull/1222)
104+
[Prior art](https://github.com/metal3-io/metal3-dev-env/pull/1523)
96105

97106
### Configure Metal3 dev-tools to sync new release branches to Nordix
98107

99108
Dev-tools synchronizes `metal3-io` changes to the `Nordix` fork for the EST
100109
folks.
101110

102-
[Prior art](https://github.com/Nordix/metal3-dev-tools/pull/672)
111+
[Prior art](https://github.com/Nordix/metal3-dev-tools/pull/784)
103112

104113
### Update testing matrix documentation
105114

@@ -121,15 +130,15 @@ Email template, with title `New CAPM3, IPAM and BMO minor releases are out!`
121130
```text
122131
Hey folks,
123132
124-
CAPM3 v1.x.y, IPAM v1.x.y, BMO v0.x.y and Ironic-image vx.y.z minor releases are out now!
125-
Release notes can be found here: [1], [2], [3], [4].
126-
133+
CAPM3 v1.x.y, IPAM v1.x.y, BMO v0.x.y, IrSO v0.x.y and Ironic-image vx.y.z minor
134+
releases are out now! Release notes can be found here: [1], [2], [3], [4], [5].
127135
Thanks to all our contributors!
128136
129137
[1] https://github.com/metal3-io/cluster-api-provider-metal3/releases/tag/v1.x.y
130138
[2] https://github.com/metal3-io/ip-address-manager/releases/tag/v1.x.y
131139
[3] https://github.com/metal3-io/baremetal-operator/releases/tag/v0.x.y
132-
[4] https://github.com/metal3-io/ironic-image/releases/tag/vx.y.z
140+
[4] https://github.com/metal3-io/ironic-standalone-operator/releases/tag/vx.y.z
141+
[5] https://github.com/metal3-io/ironic-image/releases/tag/vx.y.z
133142
134143
Thanks to all our contributors!
135144
```
@@ -139,31 +148,15 @@ Slack template:
139148
```text
140149
Hey folks,
141150
142-
CAPM3 v1.x.y, IPAM v1.x.y, BMO v0.x.y and Ironic-image vx.y.z minor releases
143-
are out now! now :tada::metal3:!
151+
CAPM3 v1.x.y, IPAM v1.x.y, BMO v0.x.y, IrSO v0.x.y and Ironic-image vx.y.z minor
152+
releases are out now! now :tada::metal3:!
144153
145154
Release notes can be found here:
146155
- https://github.com/metal3-io/cluster-api-provider-metal3/releases/tag/v1.x.y
147156
- https://github.com/metal3-io/ip-address-manager/releases/tag/v1.x.y
148157
- https://github.com/metal3-io/baremetal-operator/releases/tag/v0.x.y
158+
- https://github.com/metal3-io/ironic-standalone-operator/releases/tag/vx.y.z
149159
- https://github.com/metal3-io/ironic-image/releases/tag/vx.y.z
150160
151161
Thanks to all our contributors! :blush:
152162
```
153-
154-
## Releasing process TODO
155-
156-
### BMO
157-
158-
BMO releasing to be fine-tuned.
159-
160-
1. BMO dependencies
161-
- BMO contains `keepalived`
162-
([within utility-images repo](https://github.com/metal3-io/utility-images/tree/main/keepalived))
163-
1. BMO makes assumption about the exact configuration of MariaDB.
164-
However, [mariadb-image](https://github.com/metal3-io/mariadb-image) is
165-
currently branchless.
166-
167-
### Mariadb-image
168-
169-
Mariadb-image releasing to be implemented.

0 commit comments

Comments
 (0)