-
-
Notifications
You must be signed in to change notification settings - Fork 12
Create a release-notes PR template to be used by the release tracking ticket #693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d7532fa
Create a release-notes PR template to be used by the release tracking…
NickLarsenNZ 7b9e8ae
Merge branch 'main' into chore/release-notes-template
NickLarsenNZ 8d0b09a
Apply suggestions
NickLarsenNZ 5c081cf
Apply suggestions
NickLarsenNZ 0c2021d
Apply suggestions
NickLarsenNZ 0b5019e
ci: Prevent creating a preview site for select path globs
NickLarsenNZ 8118b43
Apply suggestions
NickLarsenNZ File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
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.X" | ||
assignees: '' | ||
--- | ||
|
||
<!-- | ||
DO NOT REMOVE THIS COMMENT. It is intended for people who might copy/paste from the previous release issue. | ||
This was created by an issue template: https://github.com/stackabletech/issues/issues/new/choose. | ||
--> | ||
|
||
> [!CAUTION] | ||
> Please assign the applicable `scheduled-for/YY.M.X` label. | ||
|
||
<!-- Release placeholders YY.M.X should be replaced. --> | ||
## Release Notes for SDP YY.M.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%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 | ||
NickLarsenNZ marked this conversation as resolved.
Show resolved
Hide resolved
NickLarsenNZ marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [ ] 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 removed product versions (if there are any) | ||
- [ ] Upgrade guide: List removed operators (if there are any) | ||
- [ ] Upgrade guide: List supported Kubernetes versions | ||
``` | ||
|
||
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 | ||
- [ ] 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 | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,6 @@ MD013: | |
MD024: | ||
# Only check sibling headings | ||
siblings_only: true | ||
|
||
# MD032/blanks-around-lists | ||
MD032: false |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.