You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 0645c50
Browse filesBrowse the repository at this point in the historyBrowse files
* feat: add cockpit
* fix: set the Antora version for the cockpit docs
* refactor(release): reuse operator functions for cockpit
Replace the cockpit-specific copies of check/update/tag functions with
the operator versions, extract a merge_repo helper in
merge-release-candidate.sh, make messages repo-neutral and fix the
cockpit README bullet.
* fix: pr feedback
* refactor: make it refer to a repo
* refactor(release): use jaq for the cockpit JSON files
* refactor(release): pass versions to yq via strenv
-`-b <release>`: the release number (mandatory). This must be a semver-compatible value (i.e. without leading zeros) such as `23.1`, `23.10` etc. and will be used to create a branch with the name `release-<release>` e.g. `release-23.1`.
170
185
-`-p`: push flag (optional, default is "false"). If provided, the created branches plus any changes made as part of this process will be pushed to the origin.
171
186
-`-c`: cleanup flag (optional, default is "false"). If provided, the repository folders will be torn down on completion.
172
-
-`-w`: where to create the branch. It can be "products", "operators", "demos" or "all".
187
+
-`-w`: where to create the branch. It can be "products", "operators", "cockpit", "demos" or "all".
173
188
174
189
N.B. the flags cannot be combined (e.g. `-p -c` but not `-pc)
175
190
@@ -192,13 +207,13 @@ e.g.
192
207
To create release tags use the `create-release-candidate-branch.sh` script, called from the repository root folder. The syntax is given below:
-`-t <release-tag>`: the release tag (mandatory). This must be a semver-compatible value (i.e. major/minor/path, without leading zeros) such as `23.1.0`, `23.10.3-rc1` etc. and will be used to create a tag with the name.
199
214
-`-p`: push flag (optional, default is "false"). If provided, the changes and PRs made as part of this process will be pushed to the origin.
200
215
-`-c`: cleanup flag (optional, default is "false"). If provided, the repository folders will be torn down on completion.
201
-
-`-w`: where to create the tag and update versions in code. It can be "products", "operators" or "all".
216
+
-`-w`: where to create the tag and update versions in code. It can be "products", "operators", "cockpit" or "all".
202
217
203
218
N.B. the flags cannot be combined (e.g. `-p -c` but not `-pc)
204
219
@@ -220,6 +235,7 @@ e.g.
220
235
- update the `release-tag` in helm charts
221
236
- rebuilds the helm charts
222
237
- bumps the changelog
238
+
- for cockpit: sets the version in `package.json`, `package-lock.json` and the Helm `Chart.yaml` instead of updating `Cargo.toml` and rebuilding the Helm charts; `docs/antora.yml` and the changelog are updated like for the operators
223
239
- optional: pushes the new branch (if requested with "-p")
224
240
- optional: deletes the temporary folder (if requested with "-c")
225
241
@@ -233,12 +249,12 @@ Product and operator images will be built when these PRs are created or updated,
233
249
To merge PRs use the `merge-release-candidate.sh` script, called from the repository root folder. The syntax is given below:
-`-t <release-tag>`: the release tag (mandatory). This must be a semver-compatible value (i.e. major/minor/path, without leading zeros) such as `23.1.0`, `23.10.3-rc1` etc. and will be used to identify the PR (which was created using this tag).
240
256
-`-p`: push flag (optional, default is "false"). If provided, the PRs will be approved and merged.
241
-
-`-w`: where to create the tag and update versions in code. It can be "products", "operators" or "all".
257
+
-`-w`: where to create the tag and update versions in code. It can be "products", "operators", "cockpit" or "all".
242
258
243
259
e.g.
244
260
@@ -259,13 +275,13 @@ e.g.
259
275
The final step is to tag the merge commit from above: this is done using the `tag-release-candidate.sh` script, called from the repository root folder. The syntax is given below:
-`-t <release-tag>`: the release tag (mandatory). This must be a semver-compatible value (i.e. major/minor/path, without leading zeros) such as `23.1.0`, `23.10.3-rc1` etc. and will be used to create a tag with the name.
266
282
-`-p`: push flag (optional, default is "false"). If provided, the created commits and tags made as part of this process will be pushed to the origin.
267
283
-`-c`: cleanup flag (optional, default is "false"). If provided, the repository folders will be torn down on completion.
268
-
-`-w`: where to create the tag and update versions in code. It can be "products", "operators" or "all".
284
+
-`-w`: where to create the tag and update versions in code. It can be "products", "operators", "cockpit" or "all".
269
285
270
286
#### What this script does
271
287
@@ -281,19 +297,20 @@ The final step is to tag the merge commit from above: this is done using the `ta
281
297
Some post release steps are performed with `release/post-release.sh` script, called from the repository root folder. The syntax is given below:
-`-t <release-tag>`: the release tag (mandatory). This must be a semver-compatible value (i.e. major/minor/path, without leading zeros) such as `23.1.0`, `23.10.3` etc. and will be used to create a tag with the name.
288
304
-`-p`: push flag (optional, default is "false"). If provided, the created commits and tags made as part of this process will be pushed to the origin.
289
-
-`-w`: which repositories to update the changelogs for. It can be "products", "operators", "all" (defaults to "all").
305
+
-`-w`: which repositories to update the changelogs for. It can be "products", "operators", "cockpit", "all" (defaults to "all").
290
306
291
307
#### What this script does
292
308
293
309
- checks that the release tag exists and that all operator repositories have a clean working copy
294
310
- checks that the release tag exists and that the docker-images repository has a clean working copy
295
311
- merges the CHANGELOG.md from the release tag into main
296
312
- creates PRs for all operators
313
+
- does the same for the cockpit repository
297
314
298
315
## Build actions
299
316
@@ -325,6 +342,10 @@ on:
325
342
...
326
343
```
327
344
345
+
### Cockpit image and Helm chart
346
+
347
+
The cockpit image and Helm chart are built by `build.yaml` in the cockpit repository when a matching tag is pushed. The tag filter there must accept CalVer tags (two-digit year, e.g. `26.3.0`), otherwise tagging builds nothing.
348
+
328
349
## Post-release steps
329
350
330
351
Once the release is complete and all steps above have been verified, the documentation needs to be updated and built. This is done in a separate suite of scripts found https://github.com/stackabletech/documentation/tree/main/scripts[here]. Follow the steps given in the two scripts (there are prompts provided which allow for early-exit if things are not as they should be!).
0 commit comments