From d7532fa921211ac73bccf4c411767da375e85d4e Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Tue, 10 Dec 2024 15:46:19 +0100 Subject: [PATCH 1/6] Create a release-notes PR template to be used by the release tracking ticket Co-authored-by: Techassi --- .../PULL_REQUEST_TEMPLATE/release-notes.md | 46 +++++++++++++++++++ .markdownlint.yaml | 3 ++ 2 files changed, 49 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/release-notes.md diff --git a/.github/PULL_REQUEST_TEMPLATE/release-notes.md b/.github/PULL_REQUEST_TEMPLATE/release-notes.md new file mode 100644 index 000000000..8c4fd4f76 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/release-notes.md @@ -0,0 +1,46 @@ +--- +name: Release Notes +about: This template can be used to track the progress of the SDP Release Notes compilation +title: "chore(tracking): Release Notes for SDP XX.(X)X" +assignees: '' +--- + + + +## Release Notes for SDP XX.(X)X + +> [!TIP] +> - Use the commented out template headings in [release-notes][template]. +> - Begin each sentence on a new line. This helps with review suggestions and diffing. +> - Use xrefs for links to other parts of the documentation so that they remain valid across versions. + +[template]: https://github.com/stackabletech/documentation/blob/8dc93f28ac6d20a587f54d0a697c71fe47e8643a/modules/ROOT/pages/release-notes.adoc?plain=1#L11-L56 + +```[tasklist] +#### Release note compilation tasks +- [ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%2FYYYY-MM%2Cscheduled-for%2FYYYY-MM&type=issues&ref=advsearch) for Product and Platform release notes +- [ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%2FYYYY-MM%2Cscheduled-for%2FYYYY-MM&type=pullrequests&ref=advsearch) for Product and Platform release notes +- [ ] Optionally check the [Changelogs](https://github.com/search?q=org%3Astackabletech+path%3A*CHANGELOG.md+%22YY.MM.X%22&type=code&ref=advsearch) in case release notes were missed +- [ ] 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 +``` + +Once the above items are complete, the following checks need to be done +Each task focuses on a specific element + +```[tasklist] +#### Release note review tasks +- [ ] Check overall document structure +- [ ] Check spelling, grammar, and correct wording +- [ ] Check that internal links are xrefs +- [ ] Check that rendered links are valid +- [ ] Check that each sentence begins on a new line +``` diff --git a/.markdownlint.yaml b/.markdownlint.yaml index dbfa4558b..70c4d7aa6 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -18,3 +18,6 @@ MD013: MD024: # Only check sibling headings siblings_only: true + +# MD032/blanks-around-lists +MD032: false From 8d0b09ad34f21069e9a45c21c3c3e9456aa87e7e Mon Sep 17 00:00:00 2001 From: Nick <10092581+NickLarsenNZ@users.noreply.github.com> Date: Tue, 10 Dec 2024 19:00:40 +0100 Subject: [PATCH 2/6] Apply suggestions Co-authored-by: Techassi --- .github/PULL_REQUEST_TEMPLATE/release-notes.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release-notes.md b/.github/PULL_REQUEST_TEMPLATE/release-notes.md index 8c4fd4f76..451d1e93d 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-notes.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-notes.md @@ -1,7 +1,7 @@ --- name: Release Notes about: This template can be used to track the progress of the SDP Release Notes compilation -title: "chore(tracking): Release Notes for SDP XX.(X)X" +title: "chore(tracking): Release Notes for SDP YY.(M)M.X" assignees: '' --- @@ -28,9 +28,9 @@ assignees: '' - [ ] 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 +- [ ] Upgrade guide: List removed product versions (if there are any) +- [ ] Upgrade guide: List removed operators (if there are any) +- [ ] Upgrade guide: List supported Kubernetes versions ``` Once the above items are complete, the following checks need to be done From 5c081cffe5767f114d8c9518b695aea5412c7396 Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Wed, 11 Dec 2024 09:38:45 +0100 Subject: [PATCH 3/6] Apply suggestions Co-authored-by: Techassi --- .github/PULL_REQUEST_TEMPLATE/release-notes.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release-notes.md b/.github/PULL_REQUEST_TEMPLATE/release-notes.md index 451d1e93d..008441c04 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-notes.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-notes.md @@ -1,7 +1,7 @@ --- name: Release Notes about: This template can be used to track the progress of the SDP Release Notes compilation -title: "chore(tracking): Release Notes for SDP YY.(M)M.X" +title: "chore(tracking): Release Notes for SDP YY.M.X" assignees: '' --- @@ -10,7 +10,11 @@ assignees: '' This was created by an issue template: https://github.com/stackabletech/issues/issues/new/choose. --> -## Release Notes for SDP XX.(X)X +> [!CAUTION] +> Please assign the applicable `scheduled-for/YY.M.X` label. + + +## Release Notes for SDP YY.M.X > [!TIP] > - Use the commented out template headings in [release-notes][template]. @@ -21,8 +25,8 @@ assignees: '' ```[tasklist] #### Release note compilation tasks -- [ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%2FYYYY-MM%2Cscheduled-for%2FYYYY-MM&type=issues&ref=advsearch) for Product and Platform release notes -- [ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%2FYYYY-MM%2Cscheduled-for%2FYYYY-MM&type=pullrequests&ref=advsearch) for Product and Platform release notes +- [ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=issues&ref=advsearch) for Product and Platform release notes +- [ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=pullrequests&ref=advsearch) for Product and Platform release notes - [ ] Optionally check the [Changelogs](https://github.com/search?q=org%3Astackabletech+path%3A*CHANGELOG.md+%22YY.MM.X%22&type=code&ref=advsearch) in case release notes were missed - [ ] 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 From 0c2021d2e4f87c1a9fc7842249331d1290309652 Mon Sep 17 00:00:00 2001 From: Nick <10092581+NickLarsenNZ@users.noreply.github.com> Date: Wed, 11 Dec 2024 09:48:35 +0100 Subject: [PATCH 4/6] Apply suggestions --- .github/PULL_REQUEST_TEMPLATE/release-notes.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release-notes.md b/.github/PULL_REQUEST_TEMPLATE/release-notes.md index 008441c04..adbae7ade 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-notes.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-notes.md @@ -37,8 +37,7 @@ assignees: '' - [ ] Upgrade guide: List supported Kubernetes versions ``` -Once the above items are complete, the following checks need to be done -Each task focuses on a specific element +Each of the following tasks focuses on a specific goal and should be done once the items above have been completed. ```[tasklist] #### Release note review tasks From 0b5019ea5be7d359547c3e4c4778081de054558b Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Wed, 11 Dec 2024 10:00:12 +0100 Subject: [PATCH 5/6] ci: Prevent creating a preview site for select path globs --- .github/workflows/build.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 9de7805d3..d2a5bd512 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -2,6 +2,10 @@ name: Build site on: pull_request: + paths-ignore: + - .github/PULL_REQUEST_TEMPLATES/** + - .github/ISSUE_TEMPLATES/** + - scripts/** jobs: From 8118b43de1d707bef57d143186109a71401480e4 Mon Sep 17 00:00:00 2001 From: Nick <10092581+NickLarsenNZ@users.noreply.github.com> Date: Wed, 11 Dec 2024 10:21:31 +0100 Subject: [PATCH 6/6] Apply suggestions --- .github/PULL_REQUEST_TEMPLATE/release-notes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release-notes.md b/.github/PULL_REQUEST_TEMPLATE/release-notes.md index adbae7ade..13e3fa7e1 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-notes.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-notes.md @@ -25,9 +25,9 @@ assignees: '' ```[tasklist] #### Release note compilation tasks -- [ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=issues&ref=advsearch) for Product and Platform release notes -- [ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=pullrequests&ref=advsearch) for Product and Platform release notes -- [ ] Optionally check the [Changelogs](https://github.com/search?q=org%3Astackabletech+path%3A*CHANGELOG.md+%22YY.MM.X%22&type=code&ref=advsearch) in case release notes were missed +- [ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=issues) for Product and Platform release notes +- [ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=pullrequests) for Product and Platform release notes +- [ ] Optionally check the [Changelogs](https://github.com/search?q=org%3Astackabletech+path%3A*CHANGELOG.md+%22YY.M.X%22&type=code) in case release notes were missed - [ ] 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