-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add
reno
to manage release notes (#5397)
* first draft * add release notes * remove old settings * add reno usage instructions * page the docs team when release notes are added * add reno to the dev dependencies * Apply suggestions from code review Co-authored-by: Stefano Fiorucci <44616784+anakin87@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Daria Fokina <daria.fokina@deepset.ai> --------- Co-authored-by: Stefano Fiorucci <44616784+anakin87@users.noreply.github.com> Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
- Loading branch information
1 parent
afabc78
commit 363f3ed
Showing
5 changed files
with
90 additions
and
11 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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 |
---|---|---|
|
@@ -218,6 +218,7 @@ dev = [ | |
"jupytercontrib", | ||
"watchdog", | ||
"toml", | ||
"reno", | ||
] | ||
|
||
formatting = [ | ||
|
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,45 @@ | ||
default_branch: main | ||
collapse_pre_releases: true | ||
template: | | ||
--- | ||
prelude: > | ||
Replace this text with content to appear at the top of the section for this | ||
release. This is equivalent to the "Highlights" section we used before. | ||
The prelude might repeat some details that are also present in other notes | ||
from the same release, that's ok. Not every release note requires a prelude, | ||
use it only to describe major features or notable changes. | ||
upgrade: | ||
- | | ||
List upgrade notes here, or remove this section. | ||
Upgrade notes should be rare: only list known/potential breaking changes, | ||
or major changes that require user action before the upgrade. | ||
Notes here must include steps that users can follow to 1. know if they're | ||
affected and 2. handle the change gracefully on their end. | ||
features: | ||
- | | ||
List new features here, or remove this section. | ||
enhancements: | ||
- | | ||
List new behavior that is too small to be | ||
considered a new feature, or remove this section. | ||
issues: | ||
- | | ||
List known issues here, or remove this section. For example, if some change is experimental or known to not work in some cases, it should be mentioned here. | ||
deprecations: | ||
- | | ||
List deprecations notes here, or remove this section. Deprecations should not be used for something that is removed in the release, use upgrade section instead. Deprecation should allow time for users to make necessary changes for the removal to happen in a future release. | ||
security: | ||
- | | ||
Add security notes here, or remove this section. | ||
fixes: | ||
- | | ||
Add normal bug fixes here, or remove this section. | ||
sections: | ||
# The prelude section is implicitly included. | ||
- [upgrade, Upgrade Notes] | ||
- [features, New Features] | ||
- [enhancements, Enhancement Notes] | ||
- [issues, Known Issues] | ||
- [deprecations, Deprecation Notes] | ||
- [security, Security Notes] | ||
- [fixes, Bug Fixes] |
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,11 @@ | ||
--- | ||
prelude: > | ||
Release notes are now managed by `reno`. The main difference is that | ||
every contributor is responsible for adding release notes for the feature or bugfix they're | ||
introducing in Haystack in the very same Pull Request containing the code changes. The | ||
goal is to encourage detailed and accurate notes for every release, especially when it comes | ||
to complex features or breaking changes. | ||
upgrade: | ||
- | | ||
If you're a Haystack contributor, you need a new tool called `reno` to manage the release notes. | ||
Please run `pip install -e .[dev]` to ensure you have `reno` available in your environment. |