From bcb3c42a3dfedb5304b6922f6a10edcaf0f592f9 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Mon, 11 May 2026 12:56:36 +0200 Subject: [PATCH 1/2] feat: Fetch tags from GitHub, use only latest from SDP release line --- README.md | 24 ++++-- repos.yaml | 247 +++++------------------------------------------------ shell.nix | 9 ++ 3 files changed, 44 insertions(+), 236 deletions(-) create mode 100644 shell.nix diff --git a/README.md b/README.md index 60d35f1..5a8f5c8 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,12 @@ https://crds.stackable.tech/ -## Building +## Building & Running -run `make`, the site is generated in the `site` directory. +First run `git submodule update --init` to pull the `crddocs-generator`. + +Afterwards run `make`, the site is generated in the `site` directory. +To access the rendered contents use `make serve`. Generated with https://github.com/stackabletech/crddocs-generator (have a look there for how it works). @@ -27,10 +30,15 @@ There was a slight modification for navbar alignment. ### How to add a new platform release -The docs are built for all the repos and branches configured in the `repos.yaml` file. -so if this file is updated and merged into main, the automated Netlify build will automatically build -new documentation for any changes. Instructions: +The docs are built for all the repos configured in the `repos.yaml` file. The +list of versions is auto-discovered from GitHub at build time: all calver tags +(`YY.M.P`) on each repo are listed and only the latest patch per `YY.M` +release line is kept (e.g. `24.11.0` is hidden once `24.11.1` exists). +`nightly` (tracking `main`) is always included. + +A new SDP release therefore only needs the operator repos to be tagged on +GitHub — no change to `repos.yaml` is required. Trigger the "Trigger Netlify +build hook" GitHub action (or wait for the next build) to pick it up. -- Add the new {major}.{minor}.{patch} version for all `repos` as well as a `platformVersion` to the `repos.yaml` file. -- Merge these changes into main. -- Wait 5 minutes for the Netlify build to update the page. You can also manually run the "Trigger Netlify build hook" GitHub action to trigger a build. +To add or remove a repo from the site, edit the flat list in `repos.yaml` and +merge to main. diff --git a/repos.yaml b/repos.yaml index 790b188..8ef9dab 100644 --- a/repos.yaml +++ b/repos.yaml @@ -1,230 +1,21 @@ --- +# Tags per repo are auto-discovered from GitHub at build time: +# all calver tags (YY.M.P) are listed and only the latest patch per +# YY.M release line is kept. `nightly` (tracking main) is always added. repos: - airflow-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - druid-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - hbase-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - hdfs-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - hive-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - kafka-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - nifi-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - opensearch-operator: - - "26.3.0" - - "25.11.0" - - "nightly" - spark-k8s-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - superset-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - trino-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - zookeeper-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - opa-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - commons-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - secret-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - listener-operator: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" - -platformVersions: - - "26.3.0" - - "25.11.0" - - "25.7.0" - - "25.3.0" - - "24.11.1" - - "24.11.0" - - "24.7.0" - - "24.3.0" - - "23.11.0" - - "23.7.0" - - "23.4.1" - - "23.1.0" - - "nightly" + - airflow-operator + - druid-operator + - hbase-operator + - hdfs-operator + - hive-operator + - kafka-operator + - nifi-operator + - opensearch-operator + - spark-k8s-operator + - superset-operator + - trino-operator + - zookeeper-operator + - opa-operator + - commons-operator + - secret-operator + - listener-operator diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..28ac6a5 --- /dev/null +++ b/shell.nix @@ -0,0 +1,9 @@ +{ + pkgs ? import { }, +}: +pkgs.mkShell { + nativeBuildInputs = with pkgs; [ + sqlite + go + ]; +} From d38f03748261f335cd6272ea85e1beb800dc767a Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 13 May 2026 17:30:34 +0200 Subject: [PATCH 2/2] Bump --- crddocs-generator | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crddocs-generator b/crddocs-generator index c1d7898..440ccef 160000 --- a/crddocs-generator +++ b/crddocs-generator @@ -1 +1 @@ -Subproject commit c1d7898d2074ed9e4f98de4d51a4f88d759b3060 +Subproject commit 440ccef1b5cbab87bdcff5980ab0aa6fbcd9160a