chore: Add pre-release PR template to run and update nightly demos #64
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Run and Update Demos on Nightly for Stackable Release XX.(X)X | ||
|
|
||
| <!-- | ||
| Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/release.md' | ||
| when you rename this file. | ||
| --> | ||
|
|
||
| <!-- | ||
| Replace 'TRACKING_ISSUE' with the applicable release tracking issue number. | ||
| --> | ||
|
|
||
| Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE> | ||
|
|
||
| > [!NOTE] | ||
| > Demos run on the latest stable release by default. This PR includes changes | ||
| > to commands, documentation and UI screenshots when running the demos on | ||
| > nightly instead. The recommended workflow looks like this: | ||
| > | ||
| > 1. Create a `.env` file in your local copy of this repository. | ||
| > 2. Create local stack and demo definition files, like `stacks-v2.local.yaml` | ||
| > and `demos-v2.local.yaml`. They should use the nightly version instead of | ||
| > stable. They also might need to point to local manifests instead of remote | ||
| > ones. | ||
| > 3. Add the `STACKABLE_STACK_FILES` and `STACKABLE_DEMO_FILES` env vars to the | ||
| > file. They should point to the absolute path of your local stack and demo | ||
| > definition files. | ||
|
Comment on lines
+19
to
+26
There was a problem hiding this comment. Just adding a different perspective to consider... Tbh, I prefer using the checked out stack files explicitly on the command line. Not at all suggesting my way is better, but for me, doing the above, I would forget to unset the variable, or I would run a new shell that doesn't have it set, and invalidate the testing). I use the shell history heavily. |
||
| > 4. Install the demo as usual ` stackablectl demo install <DEMO>`. | ||
| > 5. Update the documentation and images when required. | ||
|
|
||
| <!-- | ||
| The following list was generated by: | ||
|
|
||
| yq '.demos | keys' demos/demos-v2.yaml \ | ||
| | sed -e 's/- //g' \ | ||
| | sort \ | ||
| | xargs -I {} echo "- [ ] [{}](https://docs.stackable.tech/home/nightly/demos/{})" | ||
| --> | ||
|
|
||
| ```[tasklist] | ||
| ### Demos | ||
| - [ ] [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) | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,8 @@ | ||
| # Environment variables, for example for stackablectl | ||
| .env | ||
|
|
||
| # Local demo and stack definition files | ||
| stacks-v1.local.yaml | ||
| stacks-v2.local.yaml | ||
| demos-v1.local.yaml | ||
| demos-v2.local.yaml |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There probably needs to be another list for things to check during the demos.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the release upgrade testing, we would modify it to ensure that the correct product versions are used, and the SDP X.XX version is used (not 0.0.0-dev).
On top of that, I think the demo should be run (according to the docs), and then the upgrade should be done. This mimics a real upgrade where there was data.