Skip to content

Commit 0330c62

Browse files
chore: Move release note tasks to a separate template (stackabletech/documentation#693)
Co-authored-by: Techassi <[email protected]>
1 parent a165f0e commit 0330c62

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

.github/ISSUE_TEMPLATE/release.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,17 +88,15 @@ This will not be so crucial with release branches, but is nonetheless sensible a
8888
- [ ] OpenShift testing on Rosa <!-- where is that at? -->
8989
```
9090

91+
> [!TIP]
92+
> Name the release-notes branch `docs/release-notes-XX.XX.X` so that the link below takes you directly to the [Pull Request template][docs-pr-template].
93+
94+
[docs-pr-template]: https://github.com/stackabletech/documentation/blobs/main/.github/PULL_REQUEST_TEMPLATE/release-notes.md
95+
9196
```[tasklist]
9297
#### Documentation tasks
93-
- [ ] Check the Changelog and/or issue labels to compile Release Highlights
94-
- [ ] Compile list of new product versions that are supported and compile a list of new product features to include in the Release Highlights
95-
- [ ] Upgrade guide: Document how to use stackablectl to uninstall all and install new release
96-
- [ ] Upgrade guide: Document how to use helm to uninstall all and install new release
97-
- [ ] Upgrade guide: Every breaking change of all our operators
98-
- [ ] Upgrade guide: List dropped supported product versions (if there are some)
99-
- [ ] Upgrade guide: List dropped supported operators (if there are some)
100-
- [ ] Upgrade guide: List supported k8s versions
101-
- [ ] The team reviews the preview release notes: (structure, wording, xrefs and links, sentences on new lines)
98+
- [ ] Create a stackabletech/documentation branch called `docs/release-notes-XX.XX.X`
99+
- [ ] Begin writing the release notes with the [Pull Request template](https://github.com/stackabletech/documentation/compare/main...docs/release-notes-XX.XX.X?template=release-notes.md)
102100
- [ ] Update SDP release version in documentation/modules/ROOT/pages/getting-started.adoc and test the release install command
103101
- [ ] Cut a release branch (see [scripts/make-release-branch.sh](https://github.com/stackabletech/documentation/blob/main/scripts/make-release-branch.sh))
104102
- [ ] Update releases in the playbook (see [scripts/publish-new-version.sh](https://github.com/stackabletech/documentation/blob/main/scripts/publish-new-version.sh))

0 commit comments

Comments
 (0)