-
Notifications
You must be signed in to change notification settings - Fork 154
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build(release): use reno for release notes
- Loading branch information
Showing
5 changed files
with
55 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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,18 @@ | ||
## Release notes | ||
|
||
Release notes for Kanister starting with version 0.104.0 use [https://docs.openstack.org/reno/latest/](reno) | ||
|
||
Release notes are stored in `releasenotes/notes` directory. | ||
|
||
Reno allows to generate release notes using files in the repository as opposed to generating from commit messages. | ||
This makes it easier to review and edit release notes. | ||
|
||
## Development flow | ||
|
||
When submitting a PR with some changes worthy of mentioning in the notes (new feature, bugfix, deprecation, update requirements), | ||
committer should add a new note file using `reno new <note_name>` or `make reno-new note=<note_name>`. | ||
New file will be created in `releasenotes/notes` directory with default template. | ||
Change notes should be added to this file to reflect the change and additional information such as deprecations or upgrade requirements. | ||
It's recommended to remove unused template fields. | ||
|
||
When reviewing a PR, a reviewer should check if there are change notes added if necessary and either request or add a new note if they have push access to the branch |
This file contains 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,27 @@ | ||
--- | ||
collapse_pre_releases: false | ||
earliest_version: 0.104.0 | ||
add_release_date: false | ||
stop_at_branch_base: true | ||
ignore_notes: [] | ||
|
||
sections: | ||
- [features, New Features] | ||
- [fixes, Bug Fixes] | ||
- [security, Security Issues] | ||
- [issues, Known Issues] | ||
- [upgrade, Upgrade Notes] | ||
- [deprecations, Deprecations] | ||
- [other, Other Notes] | ||
|
||
prelude_section_name: release_summary | ||
template: | | ||
--- | ||
release_summary: | ||
features: | ||
issues: | ||
upgrade: | ||
deprecations: | ||
security: | ||
fixes: | ||
other: |