diff --git a/.github/ISSUE_TEMPLATE/olm_manifests.md b/.github/ISSUE_TEMPLATE/olm_manifests.md index 1a6f0cb..42b6900 100644 --- a/.github/ISSUE_TEMPLATE/olm_manifests.md +++ b/.github/ISSUE_TEMPLATE/olm_manifests.md @@ -1,7 +1,7 @@ --- name: OLM Manifest Guide about: A task list for OLM manifest generation for certification -title: 'OLM Manifests for release xxx' +title: 'OLM Manifests for SDP Release YY.M.X' labels: '' assignees: '' --- @@ -63,14 +63,14 @@ This issue assumes you are generating OLM manifests for a released SDP version w ### Generate manifests -- [ ] Update the supported OpenShift version range in the function [generate_metadata()](https://github.com/stackabletech/stackable-utils/blob/273ec983d6c0b1ea1852d9633ed56b8123054b39/olm/build-manifests.sh#L39) +- [ ] Update the supported OpenShift version range in the function [generate_metadata()](https://github.com/stackabletech/stackable-utils/blob/273ec983d6c0b1ea1852d9633ed56b8123054b39/olm/build-manifests.sh#L39) - [ ] Create release branch (from `main`) in the openshift operator repository cd $HOME/repo/stackable/openshift-certified-operators git switch -c stackable-secret-24.11.0 - + - [ ] Generate manifests - + ./olm/build-manifests.sh -r 24.11.0 \ -c $HOME/repo/stackable/openshift-certified-operators \ -o $HOME/repo/stackable/secret-operator diff --git a/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md b/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md index 928e998..f592c70 100644 --- a/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md +++ b/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md @@ -1,14 +1,14 @@ --- -name: Pre-Release Getting Started Script Update -about: This template can be used to track the update of the "Getting Started" scripts in this repository leading up to the next Stackable release -title: "chore(tracking): Check and update getting-started scripts" +name: Getting Started Script Checks (Pre-Release) +about: This template can be used to track the checks/updates of the "Getting Started" scripts in this repository leading up to the next Stackable release +title: "chore(tracking): Check and update getting-started scripts before SDP Release YY.M.X" labels: ['epic'] assignees: '' --- -## Pre-Release Getting Started Script Updates +## Getting Started Script Checks (Pre-Release) Part of @@ -42,12 +42,12 @@ popd > [!TIP] > Create branches with predictable names so the links below work. Remember -> to replace `xx.(x)x` with the appropriate release version: +> to replace `YY.M.X` with the appropriate release version: > > ```sh > git stash -m "unsaved work" > git fetch origin -> git checkout -b fix/getting-started-pre-xx.(x)x origin/main +> git checkout -b fix/getting-started-pre-YY.M.X origin/main > ``` > > Then use the links below to automatically create applicable PRs for each operator @@ -59,29 +59,30 @@ Replace the items in the task lists below with the applicable Pull Requests (if The following list was generated by: # go to the operator-templating repository, then run: - STACKABLE_RELEASE=24.11 + MAIN_BRANCH=main + STACKABLE_RELEASE=YY.M.X 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-${STACKABLE_RELEASE}?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-${STACKABLE_RELEASE})" + | xargs -I {} echo "- [ ] [Update getting-started script for {}](https://github.com/stackabletech/{}/compare/${MAIN_BRANCH}...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.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) +- [ ] [Update getting-started script for airflow-operator](https://github.com/stackabletech/airflow-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for commons-operator](https://github.com/stackabletech/commons-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for druid-operator](https://github.com/stackabletech/druid-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for edc-operator](https://github.com/stackabletech/edc-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for hbase-operator](https://github.com/stackabletech/hbase-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for hdfs-operator](https://github.com/stackabletech/hdfs-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for hello-world-operator](https://github.com/stackabletech/hello-world-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for hive-operator](https://github.com/stackabletech/hive-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for kafka-operator](https://github.com/stackabletech/kafka-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for listener-operator](https://github.com/stackabletech/listener-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for nifi-operator](https://github.com/stackabletech/nifi-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for opa-operator](https://github.com/stackabletech/opa-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for secret-operator](https://github.com/stackabletech/secret-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for spark-k8s-operator](https://github.com/stackabletech/spark-k8s-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for superset-operator](https://github.com/stackabletech/superset-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for trino-operator](https://github.com/stackabletech/trino-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) +- [ ] [Update getting-started script for zookeeper-operator](https://github.com/stackabletech/zookeeper-operator/compare/main...fix/getting-started-pre-YY.M.X?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-YY.M.X) ``` diff --git a/.github/ISSUE_TEMPLATE/pre-release-openshift-tests.md b/.github/ISSUE_TEMPLATE/pre-release-openshift-tests.md index a10b747..b5cdf7a 100644 --- a/.github/ISSUE_TEMPLATE/pre-release-openshift-tests.md +++ b/.github/ISSUE_TEMPLATE/pre-release-openshift-tests.md @@ -1,7 +1,7 @@ --- name: Pre-Release OpenShift Integration Tests about: This template can be used to track the integration testing on OpenShift leading up to the next Stackable release -title: "chore(tracking): Run integration tests on OpenShift" +title: "chore(tracking): Run integration tests on OpenShift before SDP Release YY.M.X" labels: ['epic'] assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md b/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md index dcf0549..82cd623 100644 --- a/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md +++ b/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md @@ -1,7 +1,7 @@ --- name: Pre-Release Operator Rust Updates about: This template can be used to track the progress of Rust updates across our operators leading up to the Stackable release -title: "chore(tracking): Update Rust dependencies of operators for Stackable release XX.(X)X" +title: "chore(tracking): Update Rust dependencies of operators before SDP Release YY.M.X" labels: ['epic'] assignees: '' --- @@ -28,12 +28,12 @@ Replace the items in the task lists below with the applicable Pull Requests > [!TIP] > Create branches with predictable names so the links below work. Remember -> to replace `xx.(x)x` with the appropriate release version: +> to replace `YY.M.X` with the appropriate release version: > > ```sh > git stash -m "unsaved work" > git fetch origin -> git checkout -b chore/bump-rust-deps-pre-xx.(x)x origin/main +> git checkout -b chore/bump-rust-deps-pre-YY.M.X origin/main > ``` > > Then use the links below to automatically create applicable PRs for each operator diff --git a/.github/ISSUE_TEMPLATE/release-getting-started-scripts.md b/.github/ISSUE_TEMPLATE/release-getting-started-scripts.md new file mode 100644 index 0000000..98db3c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release-getting-started-scripts.md @@ -0,0 +1,93 @@ +--- +name: Getting Started Script Checks (Release) +about: This template can be used to track the checks/updates of the "Getting Started" scripts in this repository for a new Stackable release +title: "chore(tracking): Check and update getting-started scripts for SDP Release YY.M.X" +labels: ['epic'] +assignees: '' +--- + + + + + +## Getting Started Script Checks (Release) + +Part of + +> [!CAUTION] +> These steps are to be taken once the release branch exists. + +In each operator repository, run the following commands. If any updates are +required, open a PR using the applicable link below. + +```shell +git checkout release-YY.M + +# Some of the scripts are in a code/ subdirectory +# pushd docs/modules/superset/examples/getting_started +# pushd docs/modules/superset/examples/getting_started/code +pushd $(fd -td getting_started | grep examples); cd code 2>/dev/null || true + +# Make a fresh cluster (~12 seconds) +kind delete cluster && kind create cluster +./getting_started.sh stackablectl + +# Make a fresh cluster (~12 seconds) +kind delete cluster && kind create cluster +./getting_started.sh helm + +popd +``` + +> [!TIP] +> Create branches with predictable names so the links below work. Remember +> to replace `YY.M` and `YY.M.X` with the appropriate release version: +> +> ```sh +> git stash -m "unsaved work" +> git fetch origin +> git checkout -b fix/getting-started-YY.M.X origin/release-YY.M +> ``` +> +> Then use the links below to automatically create applicable PRs for each operator +> using the PR template. + +Replace the items in the task lists below with the applicable Pull Requests (if any). + + + +```[tasklist] +### Getting Started Script Checks and Updates +- [ ] [Update getting-started script for airflow-operator](https://github.com/stackabletech/airflow-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for commons-operator](https://github.com/stackabletech/commons-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for druid-operator](https://github.com/stackabletech/druid-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for edc-operator](https://github.com/stackabletech/edc-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for hbase-operator](https://github.com/stackabletech/hbase-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for hdfs-operator](https://github.com/stackabletech/hdfs-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for hello-world-operator](https://github.com/stackabletech/hello-world-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for hive-operator](https://github.com/stackabletech/hive-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for kafka-operator](https://github.com/stackabletech/kafka-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for listener-operator](https://github.com/stackabletech/listener-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for nifi-operator](https://github.com/stackabletech/nifi-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for opa-operator](https://github.com/stackabletech/opa-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for secret-operator](https://github.com/stackabletech/secret-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for spark-k8s-operator](https://github.com/stackabletech/spark-k8s-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for superset-operator](https://github.com/stackabletech/superset-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for trino-operator](https://github.com/stackabletech/trino-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +- [ ] [Update getting-started script for zookeeper-operator](https://github.com/stackabletech/zookeeper-operator/compare/release-YY.M...fix/getting-started-YY.M.X?quick_pull=1&template=release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+YY.M.X) +``` diff --git a/.github/ISSUE_TEMPLATE/release-retro.md b/.github/ISSUE_TEMPLATE/release-retro.md new file mode 100644 index 0000000..6d9e1a5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release-retro.md @@ -0,0 +1,35 @@ +--- +name: Release Retro +about: This template can be used to record items throughout the release which are to be discuss end the Release Retro +title: "Release Retro YY.M.X" +labels: [] +assignees: '' +--- + +After the YY.M.X release, we will hold a release-retro to discuss what went well, and find out where we can improve. + +- [ ] Schedule the retro +- [ ] Create action items during the retro + +The task list below can capture items as we think of them. + + +```[tasklist] +### Items for discussion +``` + + +> [!TIP] +> During the retro, edit this description and remove the commented actions task list below + + + diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index b087a2f..ff0b874 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -1,7 +1,7 @@ --- name: Release Tracking about: This template can be used to track the progress of the SDP -title: "chore(tracking): Release SDP XX.(X)X" +title: "chore(tracking): SDP Release YY.M.X" labels: ['epic'] assignees: '' @@ -12,7 +12,7 @@ assignees: '' This was created by an issue template: https://github.com/stackabletech/issues/issues/new/choose. --> -# Stackable Release XX.(X)X +# Stackable Release YY.M.X > [!IMPORTANT] > Important dates: @@ -31,6 +31,8 @@ Replace the items in the task lists below with the applicable Pull Requests / Is ```[tasklist] ### Early Pre-release tasks +- [ ] [Create a "Release Retro" issue](https://github.com/stackabletech/issues/issues/new?template=release-retro.md) +- [ ] Define product versions to include in the next release - [ ] [Update and release operator-rs workspace members](https://github.com/stackabletech/operator-rs/issues/new?template=release-workspace-members.md) - [ ] [Update Rust toolchain of operators](https://github.com/stackabletech/operator-templating/issues/new?template=pre-release.md) - [ ] [Update Rust dependencies of operators](https://github.com/stackabletech/issues/issues/new?template=pre-release-operator-rust-deps.md) @@ -43,16 +45,16 @@ Replace the items in the task lists below with the applicable Pull Requests / Is ```[tasklist] ### Pre-release - [ ] Run all of the test suites in Jenkins (with all product versions, not just "nightly") -- [ ] [Check and update getting-started script](https://github.com/stackabletech/issues/issues/new?template=pre-release-getting-started-scripts.md) +- [ ] [Check and update getting-started scripts](https://github.com/stackabletech/issues/issues/new?template=pre-release-getting-started-scripts.md) - [ ] [Check and update demo charts](https://github.com/stackabletech/demos/issues/new?template=pre-release-chart-updates.md) -- [ ] [Test and update demos stable to nightly](https://github.com/stackabletech/demos/issues/new?template=pre-release-nightly-testing.md) +- [ ] [Test demos and upgrade from stable to nightly release](https://github.com/stackabletech/demos/issues/new?template=pre-release-upgrade-testing.md) - [ ] Ensure integration tests are successful on OpenShift - [ ] Check stackable-utils scripts in dry-run mode work ``` ### Other Pre-Requisites (before Feature Freeze) -Search for open issues labeleded with [`scheduled-for/20XX-X`](https://github.com/search?q=org%3Astackabletech+label%3Ascheduled-for%2F20XX-X&type=issues&state=open) +Search for open issues labeleded with [`scheduled-for/YY.M.X`](https://github.com/search?q=org%3Astackabletech+label%3Ascheduled-for%2FYY.M.X&type=issues&state=open) ```[tasklist] ### Other release-specific pre-requisites @@ -68,35 +70,37 @@ This will not be so crucial with release branches, but is nonetheless sensible a ```[tasklist] #### Technical tasks - [ ] Temporarily remove branch protection before pushing the release branches/tags -- [ ] Create release branches for docker-images (see stackable-utils for script to create branches) +- [ ] Create release branch for docker-images (see stackable-utils for script to create branches) - [ ] Create release tag(s) for docker-images (see stackable-utils for scripts to create tags) - [ ] Create release branches for operators (see stackable-utils for script to create branches) - [ ] Create release tag(s) for operators (see stackable-utils for scripts to create tags) - [ ] Create release tag for stackable-cockpit (optional, highly experimental, requires manual tag creation) - [ ] Update release version in changelogs on main branches (see stackable-utils for script to do this) +- [ ] Create release branch for demos (see stackable-utils for script to create branches) - [ ] Generate CRD docs [website](https://crds.stackable.tech/) for the new release by following these [instructions](https://github.com/stackabletech/crddocs) -- [ ] Check (selected) integration tests on the new release branches -- [ ] Run/Check getting started scripts, ensure image pulls for the release works -- [ ] Run/Check demos with dev release and main branch and create draft PR for release-related changes - [ ] Test `stackablectl` with locally updated (to new release number) `releases.yaml` - [ ] Update `release.yaml` in https://github.com/stackabletech/release/blob/main/releases.yaml -- [ ] Check that an upgrade can be performed on an existing cluster without data loss. -- [ ] Run all of the test suites +- [ ] [Check and update getting-started scripts](https://github.com/stackabletech/issues/issues/new?template=release-getting-started-scripts.md) +- [ ] [Test demos and upgrade from previous to this release](https://github.com/stackabletech/demos/issues/new?template=release-upgrade-testing.md) +- [ ] Check that an upgrade can be performed on an existing cluster without data loss (cycling demo) +- [ ] Run all integration tests (for both `x86_64` and `aarch64`) +- [ ] OpenShift testing (discuss internally) ``` +> [!TIP] +> Name the release-notes branch `docs/release-notes-YY.M.X` so that the link below takes you directly to the [Pull Request template][docs-pr-template]. + +[docs-pr-template]: https://github.com/stackabletech/documentation/tree/main/.github/PULL_REQUEST_TEMPLATE/release-notes.md&title=chore(tracking):%20Release%20Notes%20for%20SDP%20YY.M.X + ```[tasklist] #### Documentation tasks -- [ ] Check the Changelog and/or issue labels to compile Release Highlights -- [ ] Compile list of new product versions that are supported and compile a list of new product features to include in the Release Highlights -- [ ] Upgrade guide: Document how to use stackablectl to uninstall all and install new release -- [ ] Upgrade guide: Document how to use helm to uninstall all and install new release -- [ ] Upgrade guide: Every breaking change of all our operators -- [ ] Upgrade guide: List dropped supported product versions (if there are some) -- [ ] Upgrade guide: List dropped supported operators (if there are some) -- [ ] Upgrade guide: List supported k8s versions -- [ ] Update version of main documentation repo (antora.yml on the release branch) -- [ ] Update SDP release version in documentation/modules/ROOT/pages/getting-started.adoc -- [ ] Set the release to "Released" in the Feature Tracker and create a new release +- [ ] Create a stackabletech/documentation branch called `docs/release-notes-YY.M.X` +- [ ] Begin writing the release notes with the [Pull Request template](https://github.com/stackabletech/documentation/compare/main...docs/release-notes-YY.M.X?template=release-notes.md&title=chore(tracking):%20Release%20Notes%20for%20SDP%20YY.M.X) +- [ ] Update SDP release version in documentation/modules/ROOT/pages/getting-started.adoc and test the release install command +- [ ] Cut a release branch (see [scripts/make-release-branch.sh](https://github.com/stackabletech/documentation/blob/main/scripts/make-release-branch.sh)) +- [ ] Update releases in the playbook (see [scripts/publish-new-version.sh](https://github.com/stackabletech/documentation/blob/main/scripts/publish-new-version.sh)) +- [ ] Update antora.yaml version in stackabletech/demos on the release branch - the stackable-utils release-scripts should do this like they do for products and operators. +- [ ] Set the release to "Released" in the Feature Tracker and create a new release (how?) - [ ] Update the getting-started page in the main docs and check it works with this release: https://github.com/stackabletech/documentation/blob/main/modules/ROOT/pages/getting-started.adoc ``` @@ -122,14 +126,10 @@ Marketing tasks can now reference published documentation. ``` ```[tasklist] -### Post-release tasks +#### Post-release tasks - [ ] Update the list of supported SDP releases in Jira (ping Jim) -- [ ] Bump Rust version. This can be done [in this file](https://github.com/stackabletech/operator-templating/blob/main/config/rust.yaml) by changing `rust_version` and also for the ubi base image [here](https://github.com/stackabletech/docker-images/blob/main/ubi8-rust-builder/Dockerfile#L25). Please be aware that this action will change it for all repositories at the same time (when merging the templating PRs). -- [ ] Check/bump versions of kube-rs and k8s-openapi (also checking the version of k8s we build against) -- [ ] Check/bump ubi9 base image -- [ ] preflight now checks automatically it's own version and only runs if latest ~~Check/bump preflight~~ - [ ] Openshift certification. Create an issue from this [template](https://github.com/stackabletech/issues/blob/main/.github/ISSUE_TEMPLATE/olm_manifests.md) for the OLM manifests -- [ ] Define product versions to include in the next release -- [ ] Add branch protection to release branches once they are stable -- [ ] Mark any end-of-life releases as such [in the documentation](https://github.com/stackabletech/documentation/blob/f751e7ff7cddacae7d2c6c2c6c1d1c877c7aa11c/antora.yml#L18) +- [ ] Mark any releases older than one year as "end-of-life" [in the documentation](https://github.com/stackabletech/documentation/blob/f751e7ff7cddacae7d2c6c2c6c1d1c877c7aa11c/antora.yml#L18) How? Ask Lars of course. He's good at that stuff. +- [ ] Post YY.M.X release retro (use issue created at the start of the process) +- [ ] [Create the next release tracking task](https://github.com/stackabletech/issues/issues/new?template=release.md) (if the date is available) ```