Skip to content

Commit 8cef5b2

Browse files
Create a release-notes PR template to be used by the release tracking ticket (#693)
* Create a release-notes PR template to be used by the release tracking ticket Co-authored-by: Techassi <[email protected]> * Apply suggestions Co-authored-by: Techassi <[email protected]> * Apply suggestions Co-authored-by: Techassi <[email protected]> * Apply suggestions * ci: Prevent creating a preview site for select path globs * Apply suggestions --------- Co-authored-by: Techassi <[email protected]>
1 parent 8dc93f2 commit 8cef5b2

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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 YY.M.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+
> [!CAUTION]
14+
> Please assign the applicable `scheduled-for/YY.M.X` label.
15+
16+
<!-- Release placeholders YY.M.X should be replaced. -->
17+
## Release Notes for SDP YY.M.X
18+
19+
> [!TIP]
20+
> - Use the commented out template headings in [release-notes][template].
21+
> - Begin each sentence on a new line. This helps with review suggestions and diffing.
22+
> - Use xrefs for links to other parts of the documentation so that they remain valid across versions.
23+
24+
[template]: https://github.com/stackabletech/documentation/blob/8dc93f28ac6d20a587f54d0a697c71fe47e8643a/modules/ROOT/pages/release-notes.adoc?plain=1#L11-L56
25+
26+
```[tasklist]
27+
#### Release note compilation tasks
28+
- [ ] 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
29+
- [ ] 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
30+
- [ ] 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
31+
- [ ] Compile list of new product versions that are supported and compile a list of new product features to include in the Release Highlights
32+
- [ ] Upgrade guide: Document how to use stackablectl to uninstall all and install new release
33+
- [ ] Upgrade guide: Document how to use helm to uninstall all and install new release
34+
- [ ] Upgrade guide: Every breaking change of all our operators
35+
- [ ] Upgrade guide: List removed product versions (if there are any)
36+
- [ ] Upgrade guide: List removed operators (if there are any)
37+
- [ ] Upgrade guide: List supported Kubernetes versions
38+
```
39+
40+
Each of the following tasks focuses on a specific goal and should be done once the items above have been completed.
41+
42+
```[tasklist]
43+
#### Release note review tasks
44+
- [ ] Check overall document structure
45+
- [ ] Check spelling, grammar, and correct wording
46+
- [ ] Check that internal links are xrefs
47+
- [ ] Check that rendered links are valid
48+
- [ ] Check that each sentence begins on a new line
49+
```

.github/workflows/build.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ name: Build site
22

33
on:
44
pull_request:
5+
paths-ignore:
6+
- .github/PULL_REQUEST_TEMPLATES/**
7+
- .github/ISSUE_TEMPLATES/**
8+
- scripts/**
59

610
jobs:
711

.markdownlint.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ MD013:
1818
MD024:
1919
# Only check sibling headings
2020
siblings_only: true
21+
22+
# MD032/blanks-around-lists
23+
MD032: false

0 commit comments

Comments
 (0)