|
| 1 | +--- |
| 2 | +name: Release Notes |
| 3 | +about: This template can be used to track the progress of the SDP Release Notes compilation |
| 4 | +title: "chore(tracking): Release Notes for SDP XX.(X)X" |
| 5 | +assignees: '' |
| 6 | +--- |
| 7 | + |
| 8 | +<!-- |
| 9 | + DO NOT REMOVE THIS COMMENT. It is intended for people who might copy/paste from the previous release issue. |
| 10 | + This was created by an issue template: https://github.com/stackabletech/issues/issues/new/choose. |
| 11 | +--> |
| 12 | + |
| 13 | +## Release Notes for SDP XX.(X)X |
| 14 | + |
| 15 | +> [!TIP] |
| 16 | +> - Use the commented out template headings in [release-notes][template]. |
| 17 | +> - Begin each sentence on a new line. This helps with review suggestions and diffing. |
| 18 | +> - Use xrefs for links to other parts of the documentation so that they remain valid across versions. |
| 19 | +
|
| 20 | +[template]: https://github.com/stackabletech/documentation/blob/8dc93f28ac6d20a587f54d0a697c71fe47e8643a/modules/ROOT/pages/release-notes.adoc?plain=1#L11-L56 |
| 21 | + |
| 22 | +```[tasklist] |
| 23 | +#### Release note compilation tasks |
| 24 | +- [ ] 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 |
| 25 | +- [ ] 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 |
| 26 | +- [ ] 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 |
| 27 | +- [ ] Compile list of new product versions that are supported and compile a list of new product features to include in the Release Highlights |
| 28 | +- [ ] Upgrade guide: Document how to use stackablectl to uninstall all and install new release |
| 29 | +- [ ] Upgrade guide: Document how to use helm to uninstall all and install new release |
| 30 | +- [ ] Upgrade guide: Every breaking change of all our operators |
| 31 | +- [ ] Upgrade guide: List dropped supported product versions (if there are some) |
| 32 | +- [ ] Upgrade guide: List dropped supported operators (if there are some) |
| 33 | +- [ ] Upgrade guide: List supported k8s versions |
| 34 | +``` |
| 35 | + |
| 36 | +Once the above items are complete, the following checks need to be done |
| 37 | +Each task focuses on a specific element |
| 38 | + |
| 39 | +```[tasklist] |
| 40 | +#### Release note review tasks |
| 41 | +- [ ] Check overall document structure |
| 42 | +- [ ] Check spelling, grammar, and correct wording |
| 43 | +- [ ] Check that internal links are xrefs |
| 44 | +- [ ] Check that rendered links are valid |
| 45 | +- [ ] Check that each sentence begins on a new line |
| 46 | +``` |
0 commit comments