Skip to content

Commit 43d4e15

Browse files
TechassiTechassi
authored
chore: Rework and split pre-release issue templates (#207)
* chore: Rework and split pre-release issue templates * chore: Update release demo testing issue template * chore: Rename issue template
1 parent d746582 commit 43d4e15

File tree

4 files changed

+215
-249
lines changed

4 files changed

+215
-249
lines changed

‎.github/ISSUE_TEMPLATE/pre-release-from-scratch-testing.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
name: Pre-Release Demo Nightly Testing
3+
about: |
4+
This template can be used to track the testing of nightly demos from scratch
5+
leading up to the next Stackable release.
6+
title: "chore(tracking): Test demos on nightly versions for YY.M.X"
7+
labels: ['epic']
8+
assignees: ''
9+
---
10+
11+
<!--
12+
Make sure to update the link in 'stackabletech/issues/.github/ISSUE_TEMPLATE/release.md' when
13+
you change the filename.
14+
-->
15+
16+
Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
17+
18+
This is testing that the _nightly_ release of the operators and products do not negatively impact
19+
the products.
20+
21+
> [!NOTE]
22+
> Record the results (issues, anomalies, or success) during the process in a comment on this issue.
23+
> Eg:
24+
>
25+
> ```md
26+
> :green_circle: **airflow-scheduled-job**
27+
>
28+
> The CRD had been updated and I needed to change the following in the manifest:
29+
> ...
30+
> ```
31+
>
32+
> The following emojis can be used to indicate the status:
33+
>
34+
> - `hourglass`: In progress / waiting
35+
> - `red_circle`: In progress with errors
36+
> - `orange_circle`: Completed with minor issues or anomalies
37+
> - `green_circle`: Completed without issues or errors
38+
39+
## List of demos
40+
41+
Replace the items in the lists below with the applicable Pull Requests (if any). Also put your
42+
GitHub handle next to the demo to indicate a particular demo was picked up for testing.
43+
44+
<!--
45+
The following list was generated by:
46+
47+
# go to the demos repository, then run:
48+
yq '.demos | keys' demos/demos-v2.yaml \
49+
| sed -e 's/- //g' \
50+
| sort \
51+
| xargs -I {} echo "- [ ] [{}](https://docs.stackable.tech/home/nightly/demos/{})"
52+
-->
53+
54+
<!-- TODO (@Techassi): Test stacks which don't have a demo -->
55+
56+
- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job)
57+
- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark)
58+
- [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security)
59+
- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/nightly/demos/hbase-hdfs-load-cycling-data)
60+
- [ ] [jupyterhub-keycloak](https://docs.stackable.tech/home/nightly/demos/jupyterhub-keycloak)
61+
- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data)
62+
- [ ] [logging](https://docs.stackable.tech/home/nightly/demos/logging)
63+
- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-earthquake-data)
64+
- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-water-level-data)
65+
- [ ] [signal-processing](https://docs.stackable.tech/home/nightly/demos/signal-processing)
66+
- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data)
67+
- [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg)
68+
- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data)
69+
70+
## Nightly from Scratch Testing Instructions
71+
72+
These instructions are for deploying and completing the nightly demo from scratch.
73+
74+
<!--
75+
Make sure to update the version mentioned below when creating the issue.
76+
-->
77+
78+
> [!TIP]
79+
> Be sure to select the _nightly_ docs version on <https://docs.stackable.tech/home/nightly/demos/>.
80+
81+
```shell
82+
# Install demo (stable operators) for the nightly release.
83+
stackablectl demo install <DEMO_NAME> --release dev
84+
85+
# --- IMPORTANT ---
86+
# Run through the nightly demo instructions (refer to the list above).
87+
```

‎.github/ISSUE_TEMPLATE/pre-release-upgrade-testing.md

Lines changed: 41 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
name: Pre-Release Demo and Upgrade Testing
2+
name: Pre-Release Demo Upgrade Testing
33
about: |
44
This template can be used to track the upgrade testing of demos from stable to
5-
nightly and nightly from scratch leading up to the next Stackable release.
6-
title: "chore(tracking): Test demos on nightly versions for YY.M.X"
5+
nightly leading up to the next Stackable release.
6+
title: "chore(tracking): Test demo upgrades on nightly versions for YY.M.X"
77
labels: ['epic']
88
assignees: ''
99
---
@@ -13,33 +13,33 @@ assignees: ''
1313
you change the filename.
1414
-->
1515

16-
<!--
17-
DO NOT REMOVE THIS COMMENT. It is intended for people who might copy/paste from the previous release issue.
18-
This was created by an issue template: https://github.com/stackabletech/demos/issues/new/choose.
19-
-->
20-
21-
## Pre-Release Demo Testing on Nightly
22-
2316
Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
2417

25-
This is testing:
26-
27-
1. That upgrades from the _stable_ release to the _nightly_ release of the operators and products do
28-
not negatively impact the products.
29-
2. That _nightly_ demos work as documented from scratch.
18+
This is testing that upgrades from the _stable_ release to the _nightly_ release of the operators
19+
and products do not negatively impact the products.
3020

3121
> [!NOTE]
32-
> Record any issues or anomalies during the process in a comment on this issue.
22+
> Record the results (issues, anomalies, or success) during the process in a comment on this issue.
3323
> Eg:
3424
>
35-
> ```plain
25+
> ```md
3626
> :green_circle: **airflow-scheduled-job**
3727
>
3828
> The CRD had been updated and I needed to change the following in the manifest:
3929
> ...
4030
> ```
31+
>
32+
> The following emojis can be used to indicate the status:
33+
>
34+
> - `hourglass`: In progress / waiting
35+
> - `red_circle`: In progress with errors
36+
> - `orange_circle`: Completed with minor issues or anomalies
37+
> - `green_circle`: Completed without issues or errors
4138
42-
Replace the items in the task lists below with the applicable Pull Requests (if any).
39+
## List of demos
40+
41+
Replace the items in the lists below with the applicable Pull Requests (if any). Also put your
42+
GitHub handle next to the demo to indicate a particular demo was picked up for testing.
4343
4444
<!--
4545
The following list was generated by:
@@ -48,30 +48,29 @@ Replace the items in the task lists below with the applicable Pull Requests (if
4848
yq '.demos | keys' demos/demos-v2.yaml \
4949
| sed -e 's/- //g' \
5050
| sort \
51-
| xargs -I {} echo "- [ ] [{}](https://docs.stackable.tech/home/nightly/demos/{})"
51+
| xargs -I {} echo "- [ ] [{}](https://docs.stackable.tech/home/stable/demos/{})"
5252
-->
5353
54-
```[tasklist]
55-
### Testing Demos on Nightly
56-
- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job)
57-
- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark)
58-
- [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security)
59-
- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/nightly/demos/hbase-hdfs-load-cycling-data)
60-
- [ ] [jupyterhub-keycloak](https://docs.stackable.tech/home/nightly/demos/jupyterhub-keycloak)
61-
- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data)
62-
- [ ] [logging](https://docs.stackable.tech/home/nightly/demos/logging)
63-
- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-earthquake-data)
64-
- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-water-level-data)
65-
- [ ] [signal-processing](https://docs.stackable.tech/home/nightly/demos/signal-processing)
66-
- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data)
67-
- [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg)
68-
- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data)
69-
```
54+
<!-- TODO (@Techassi): Test stacks which don't have a demo -->
7055
71-
### Stable to Nightly Upgrade Testing Instructions
56+
- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/stable/demos/airflow-scheduled-job)
57+
- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/stable/demos/data-lakehouse-iceberg-trino-spark)
58+
- [ ] [end-to-end-security](https://docs.stackable.tech/home/stable/demos/end-to-end-security)
59+
- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/stable/demos/hbase-hdfs-load-cycling-data)
60+
- [ ] [jupyterhub-keycloak](https://docs.stackable.tech/home/stable/demos/jupyterhub-keycloak)
61+
- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/stable/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data)
62+
- [ ] [logging](https://docs.stackable.tech/home/stable/demos/logging)
63+
- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/stable/demos/nifi-kafka-druid-earthquake-data)
64+
- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/stable/demos/nifi-kafka-druid-water-level-data)
65+
- [ ] [signal-processing](https://docs.stackable.tech/home/stable/demos/signal-processing)
66+
- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/stable/demos/spark-k8s-anomaly-detection-taxi-data)
67+
- [ ] [trino-iceberg](https://docs.stackable.tech/home/stable/demos/trino-iceberg)
68+
- [ ] [trino-taxi-data](https://docs.stackable.tech/home/stable/demos/trino-taxi-data)
69+
70+
## Stable to Nightly Upgrade Testing Instructions
7271
7372
These instructions are for deploying and completing the stable demo, and then
74-
upgading operators, CRDs, and products to the nightly versions well as upgrading
73+
upgrading operators, CRDs, and products to the nightly versions well as upgrading
7574
the operators and CRDS.
7675
7776
<!--
@@ -82,40 +81,17 @@ the operators and CRDS.
8281
> Be sure to select the _stable_ docs version on <https://docs.stackable.tech/home/stable/demos/>.
8382
8483
```shell
85-
# Install demo (stable operators) for the stable release (YY.M).
86-
# Until https://github.com/stackabletech/stackable-cockpit/issues/310 is merged,
87-
# this will need to be done by pointing stackablectl to local files checked out
88-
# from the stable release branch.
89-
git checkout release-YY.M
90-
git pull
91-
stackablectl --stack-file=stacks/stacks-v2.yaml --demo-file=demos/demos-v2.yaml demo install <DEMO_NAME>
84+
# Install demo (stable operators) for the stable release (OO.M).
85+
stackablectl demo install <DEMO_NAME>
9286
9387
# --- IMPORTANT ---
94-
# Run through the stable demo instructions (refer to the tasklist above).
88+
# Run through the stable demo instructions (refer to the list above).
9589
9690
# Get a list of installed operators
9791
stackablectl operator installed --output=plain
9892
99-
# --- OPTIONAL ---
100-
# Sometimes it is necessary to upgrade Helm charts. Look for other Helm Charts
101-
# which might need updating.
102-
103-
# First, see which charts are installed. You can ignore the stackable-operator
104-
# charts, or anything that might have been installed outside of this demo.
105-
helm list
106-
107-
# Next, add the applicable Helm Chart repositories. For example:
108-
helm repo add minio https://charts.min.io/
109-
helm repo add bitnami https://charts.bitnami.com/bitnami
110-
111-
# Finally, upgrade the Charts to what is defined in `main`.
112-
# For example:
113-
helm upgrade minio minio/minio --version x.x.x
114-
helm upgrade postgresql-hive bitnami/postgresql --version x.x.x
115-
# --- OPTIONAL END ---
116-
117-
# Uninstall operators for the stable release (YY.M)
118-
stackablectl release uninstall YY.M
93+
# Uninstall operators for the stable release (OO.M)
94+
stackablectl release uninstall OO.M
11995
12096
# Update CRDs to nightly version (on main)
12197
# Repeat this for every operator used by the demo (use the list from the earlier step before deleting the operators)
@@ -128,27 +104,3 @@ stackablectl operator install commons ...
128104
# Optionally update the product versions in the CRDs (to the latest non-experimental version for the new release), e.g.:
129105
kubectl patch hbaseclusters/hbase --type='json' -p='[{"op": "replace", "path": "/spec/image/productVersion", "value":"x.x.x"}]' # changed
130106
```
131-
132-
### Nightly from Scratch Testing Instructions
133-
134-
These instructions are for deploying and completing the nightly demo from scratch.
135-
136-
<!--
137-
Make sure to update the version mentioned below when creating the issue.
138-
-->
139-
140-
> [!TIP]
141-
> Be sure to select the _nightly_ docs version on <https://docs.stackable.tech/home/nightly/demos/>.
142-
143-
```shell
144-
# Install demo (stable operators) for the nightly release.
145-
# Until https://github.com/stackabletech/stackable-cockpit/issues/310 is merged,
146-
# this will need to be done by pointing stackablectl to local files checked out
147-
# from the main branch.
148-
git checkout main
149-
git pull
150-
stackablectl --stack-file=stacks/stacks-v2.yaml --demo-file=demos/demos-v2.yaml demo install <DEMO_NAME>
151-
152-
# --- IMPORTANT ---
153-
# Run through the nightly demo instructions (refer to the tasklist above).
154-
```

‎.github/ISSUE_TEMPLATE/release-from-scratch-testing.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
name: Release Demo and Upgrade Testing
3+
about: |
4+
This template can be used to track the upgrade testing of demos from the outgoing stable to
5+
the new release, and new release from scratch before officially marking the new release as stable.
6+
title: "chore(tracking): Test demos on nightly versions for YY.M.X"
7+
labels: ['epic']
8+
assignees: ''
9+
---
10+
11+
<!--
12+
Make sure to update the link in 'stackabletech/issues/.github/ISSUE_TEMPLATE/release.md' when
13+
you change the filename.
14+
-->
15+
16+
Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
17+
18+
This is testing that the new release demos work as documented from scratch.
19+
20+
> [!NOTE]
21+
> Record the results (issues, anomalies, or success) during the process in a comment on this issue.
22+
> Eg:
23+
>
24+
> ```md
25+
> :green_circle: **airflow-scheduled-job**
26+
>
27+
> The CRD had been updated and I needed to change the following in the manifest:
28+
> ...
29+
> ```
30+
>
31+
> The following emojis can be used to indicate the status:
32+
>
33+
> - `hourglass`: In progress / waiting
34+
> - `red_circle`: In progress with errors
35+
> - `orange_circle`: Completed with minor issues or anomalies
36+
> - `green_circle`: Completed without issues or errors
37+
38+
## List of demos
39+
40+
Replace the items in the lists below with the applicable Pull Requests (if any). Also put your
41+
GitHub handle next to the demo to indicate a particular demo was picked up for testing.
42+
43+
<!--
44+
The following list was generated by:
45+
46+
# go to the demos repository, then run:
47+
yq '.demos | keys' demos/demos-v2.yaml \
48+
| sed -e 's/- //g' \
49+
| sort \
50+
| xargs -I {} echo "- [ ] [{}](https://docs.stackable.tech/home/nightly/demos/{})"
51+
-->
52+
53+
> [!NOTE]
54+
> At this point, the new release docs are still versioned as _nightly_.
55+
56+
- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job)
57+
- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark)
58+
- [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security)
59+
- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/nightly/demos/hbase-hdfs-load-cycling-data)
60+
- [ ] [jupyterhub-keycloak](https://docs.stackable.tech/home/nightly/demos/jupyterhub-keycloak)
61+
- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data)
62+
- [ ] [logging](https://docs.stackable.tech/home/nightly/demos/logging)
63+
- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-earthquake-data)
64+
- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-water-level-data)
65+
- [ ] [signal-processing](https://docs.stackable.tech/home/nightly/demos/signal-processing)
66+
- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data)
67+
- [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg)
68+
- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data)
69+
70+
### YY.M.X from Scratch Testing Instructions
71+
72+
These instructions are for deploying and completing the YY.M.X demo from scratch.
73+
74+
<!--
75+
Make sure to update the version mentioned below when creating the issue.
76+
-->
77+
78+
> [!TIP]
79+
> Be sure to select the _nightly_ docs version on <https://docs.stackable.tech/home/nightly/demos/>.
80+
81+
```shell
82+
# Install demo (stable operators) for the nightly release.
83+
stackablectl demo install <DEMO_NAME>
84+
85+
# --- IMPORTANT ---
86+
# Run through the nightly demo instructions (refer to the list above).
87+
```

0 commit comments

Comments
 (0)