Merge pull request #602 from stackabletech/improve-release-tasklist

chore: improve the release task list with more explicit steps

Author: NickLarsenNZ

.github/ISSUE_TEMPLATE/pre-release-demos-nightly.md

@@ -8,7 +8,7 @@ assignees: ''
 
 <!--
     Make sure to update the link in '.github/ISSUE_TEMPLATE/release.md' when
-    you change the front matter above.
+    you change the filename.
 -->
 
 <!--
@@ -20,7 +20,18 @@ assignees: ''
 
 Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
 
-For each demo, run the following commands:
+> [!CAUTION]
+> Ensure the [`next` branch is merged to `main`][1], otherwise you will be testing based on old product versions.
+>
+> This is needed until [stackablectl can deploy demos for a release][2].
+>
+> [1]: https://github.com/stackabletech/demos/compare/main...next
+> [2]: https://github.com/stackabletech/stackable-cockpit/issues/310
+
+This is testing:
+
+1. The demos documented in nightly (with the updated product versions) still work.
+2. That the operators can be upgraded from the current release to the nightly release and do not negatively impact the products.
 
 > [!NOTE]
 > Record any issues or anomalies during the process in a comment on this issue.
@@ -32,10 +43,46 @@ For each demo, run the following commands:
 > ...
 > ```
 
+Replace the items in the task lists below with the applicable Pull Requests (if any).
+
+<!--
+    The following list was generated by:
+
+    # go to the demos repository, then run:
+    yq '.demos | keys' demos/demos-v2.yaml \
+    | sed -e 's/- //g' \
+    | sort \
+    | xargs -I {} echo "- [ ] [{}](https://docs.stackable.tech/home/nightly/demos/{})"
+-->
+
+```[tasklist]
+### Testing Demos on Nightly
+- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job)
+- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark)
+- [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security)
+- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/nightly/demos/hbase-hdfs-load-cycling-data)
+- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data)
+- [ ] [logging](https://docs.stackable.tech/home/nightly/demos/logging)
+- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-earthquake-data)
+- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-water-level-data)
+- [ ] [signal-processing](https://docs.stackable.tech/home/nightly/demos/signal-processing)
+- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data)
+- [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg)
+- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data)
+```
+
+<details>
+<summary>Instructions</summary>
+
+These instructions are for deploying the nightly demo, as well as upgrading the operators and CRDS.
+
 ```shell
-# Install demo (stable)
+# Install demo (stable operators)
 stackablectl demo install <DEMO_NAME>
 
+# --- IMPORTANT ---
+# Run through the nightly demo instructions (refer to the tasklist below).
+
 # Get a list of installed operators
 stackablectl operator installed --output=plain
 
@@ -70,31 +117,6 @@ stackablectl operator install commons ...
 
 # Optionally update the product versions in the CRDs, e.g.:
 kubectl patch hbaseclusters/hbase --type='json' -p='[{"op": "replace", "path": "/spec/image/productVersion", "value":"x.x.x"}]' # changed
-
 ```
 
-<!--
-    The following list was generated by:
-
-    # go to the demos repository, then run:
-    yq '.demos | keys' demos/demos-v2.yaml \
-    | sed -e 's/- //g' \
-    | sort \
-    | xargs -I {} echo "- [ ] [{}](https://docs.stackable.tech/home/nightly/demos/{})"
--->
-
-```[tasklist]
-### Testing Demos on Nightly
-- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job)
-- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark)
-- [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security)
-- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/nightly/demos/hbase-hdfs-load-cycling-data)
-- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data)
-- [ ] [logging](https://docs.stackable.tech/home/nightly/demos/logging)
-- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-earthquake-data)
-- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-water-level-data)
-- [ ] [signal-processing](https://docs.stackable.tech/home/nightly/demos/signal-processing)
-- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data)
-- [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg)
-- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data)
-```
+</details>

.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md

@@ -58,29 +58,30 @@ Replace the items in the task lists below with the applicable Pull Requests (if
 <!--
     The following list was generated by:
 
-    # go to the stackable-templating repository, then run:
+    # go to the operator-templating repository, then run:
+    STACKABLE_RELEASE=24.11
     yq '.repositories[].name' config/repositories.yaml \
     | sort \
-    | xargs -I {} echo "- [ ] [Update getting-started script for {}](https://github.com/stackabletech/{}/compare/main..fix/getting-started-pre-$(date +%y.%-m)?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-$(date +%y.%-m))"
+    | xargs -I {} echo "- [ ] [Update getting-started script for {}](https://github.com/stackabletech/{}/compare/main...fix/getting-started-pre-${STACKABLE_RELEASE}?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-${STACKABLE_RELEASE})"
 -->
 
 ```[tasklist]
 ### Getting Started Script Checks and Updates
-- [ ] [Update getting-started script for airflow-operator](https://github.com/stackabletech/airflow-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for commons-operator](https://github.com/stackabletech/commons-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for druid-operator](https://github.com/stackabletech/druid-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for edc-operator](https://github.com/stackabletech/edc-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for hbase-operator](https://github.com/stackabletech/hbase-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for hdfs-operator](https://github.com/stackabletech/hdfs-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for hello-world-operator](https://github.com/stackabletech/hello-world-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for hive-operator](https://github.com/stackabletech/hive-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for kafka-operator](https://github.com/stackabletech/kafka-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for listener-operator](https://github.com/stackabletech/listener-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for nifi-operator](https://github.com/stackabletech/nifi-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for opa-operator](https://github.com/stackabletech/opa-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for secret-operator](https://github.com/stackabletech/secret-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for spark-k8s-operator](https://github.com/stackabletech/spark-k8s-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for superset-operator](https://github.com/stackabletech/superset-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for trino-operator](https://github.com/stackabletech/trino-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
-- [ ] [Update getting-started script for zookeeper-operator](https://github.com/stackabletech/zookeeper-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7)
+- [ ] [Update getting-started script for airflow-operator](https://github.com/stackabletech/airflow-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for commons-operator](https://github.com/stackabletech/commons-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for druid-operator](https://github.com/stackabletech/druid-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for edc-operator](https://github.com/stackabletech/edc-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for hbase-operator](https://github.com/stackabletech/hbase-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for hdfs-operator](https://github.com/stackabletech/hdfs-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for hello-world-operator](https://github.com/stackabletech/hello-world-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for hive-operator](https://github.com/stackabletech/hive-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for kafka-operator](https://github.com/stackabletech/kafka-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for listener-operator](https://github.com/stackabletech/listener-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for nifi-operator](https://github.com/stackabletech/nifi-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for opa-operator](https://github.com/stackabletech/opa-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for secret-operator](https://github.com/stackabletech/secret-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for spark-k8s-operator](https://github.com/stackabletech/spark-k8s-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for superset-operator](https://github.com/stackabletech/superset-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for trino-operator](https://github.com/stackabletech/trino-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
+- [ ] [Update getting-started script for zookeeper-operator](https://github.com/stackabletech/zookeeper-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11)
 ```