Edit release notes template (#853)

- Removes the note about installing the dataframes feature.
- Moves the command changes section to the top level, renames some sub
sections, and adds some more sub sections.
- Moves and simplifies the hall of fame.
This commit is contained in:
Ian Manske 2024-05-28 19:32:39 +00:00 committed by GitHub
parent c133ab2419
commit 85205b0e66
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 37 additions and 38 deletions

View File

@ -72,7 +72,7 @@
- [ ] inspect the merged PRs to write changelogs with `./make_release/release-note/list-merged-prs nushell/nushell`
- [ ] reorder sections by priority, what makes the most sense to the user?
- [ ] paste the output of `./make_release/release-note/list-merged-prs nushell/nushell --label breaking-change --pretty --no-author` to the "*Breaking changes*" section
- [ ] paste the output of `./make_release/release-note/list-merged-prs nushell/nushell --label pr:breaking-change --pretty --no-author` to the "*Breaking changes*" section
- [ ] make sure breaking changes titles are clear enough
- [ ] paste the output of `./make_release/release-note/get-full-changelog` to the "*Full changelog*" section
- [ ] mark as *ready for review* when uploading to *crates.io*

View File

@ -18,22 +18,21 @@ Today, we're releasing version {{VERSION}} of Nu. This release adds...
Nu {{VERSION}} is available as [pre-built binaries](https://github.com/nushell/nushell/releases/tag/{{VERSION}}) or from [crates.io](https://crates.io/crates/nu). If you have Rust installed you can install it using `cargo install nu`.
::: tip Note
The optional dataframe functionality is available by `cargo install nu --features=dataframe`.
:::
As part of this release, we also publish a set of optional plugins you can install and use with Nu. To install, use `cargo install nu_plugin_<plugin name>`.
# Table of content
- [*Themes of this release / New features*](#themes-of-this-release-new-features-toc)
- [*Hall of fame*](#hall-of-fame-toc)
- [*Bug fixes*](#bug-fixes-toc)
- [*Enhancing the documentation*](#enhancing-the-documentation-toc)
- [*Our set of commands is evolving*](#our-set-of-commands-is-evolving-toc)
- [*New commands*](#new-commands-toc)
- [*Changes to existing commands*](#changes-to-existing-commands-toc)
- [*Deprecated commands*](#deprecated-commands-toc)
- [*Removed commands*](#removed-commands-toc)
- [_Highlights and themes of this release_](#highlights-and-themes-of-this-release-toc)
- [_Changes to commands_](#changes-to-commands-toc)
- [_Additions_](#additions-toc)
- [_Breaking changes_](#breaking-changes-toc)
- [_Deprecations_](#deprecations-toc)
- [_Removals_](#removals-toc)
- [_Other changes_](#other-changes-toc)
- [_Bug fixes_](#bug-fixes-toc)
- [_All breaking changes_](#all-breaking-changes-toc)
- [_Notes for plugin developers_](#notes-for-plugin-developers)
- [_Hall of fame_](#hall-of-fame-toc)
- [_Full changelog_](#full-changelog-toc)
<!-- TODO: please add links to the other sections here
the following command should help pre-generate a great deal of the table of content.
@ -44,15 +43,13 @@ As part of this release, we also publish a set of optional plugins you can insta
| each {
str replace '# ' '- '
| str replace --all '#' ' '
| str replace --regex '- (.*)' '- [*$1*](#$1-toc)'
| str replace --regex '- (.*)' '- [_$1_](#$1-toc)'
}
| to text
```
-->
- [*Breaking changes*](#breaking-changes-toc)
- [*Full changelog*](#full-changelog-toc)
# Themes of this release / New features [[toc](#table-of-content)]
# Highlights and themes of this release [[toc](#table-of-content)]
<!-- NOTE: if you wanna write a section about a breaking change, when it's a very important one,
please add the following snippet to have a "warning" banner :)
> see [an example](https://www.nushell.sh/blog/2023-09-19-nushell_0_85_0.html#pythonesque-operators-removal)
@ -67,26 +64,19 @@ As part of this release, we also publish a set of optional plugins you can insta
for the list of available *containers*
-->
## Hall of fame [[toc](#table-of-content)]
### Bug fixes [[toc](#table-of-content)]
Thanks to all the contributors below for helping us solve issues and bugs :pray:
| author | description | url |
| ------------------------------------ | ----------- | ------------------------------------------------------- |
| [@author](https://github.com/author) | ... | [#12345](https://github.com/nushell/nushell/pull/12345) |
# Changes to commands [[toc](#table-of-content)]
### Enhancing the documentation [[toc](#table-of-content)]
Thanks to all the contributors below for helping us making the documentation of Nushell commands better :pray:
| author | description | url |
| ------------------------------------ | ----------- | ------------------------------------------------------- |
| [@author](https://github.com/author) | ... | [#12345](https://github.com/nushell/nushell/pull/12345) |
## Additions [[toc](#table-of-content)]
## Our set of commands is evolving [[toc](#table-of-content)]
As usual, new release rhyms with changes to commands!
## Breaking changes [[toc](#table-of-content)]
### New commands [[toc](#table-of-content)]
### Changes to existing commands [[toc](#table-of-content)]
### Deprecated commands [[toc](#table-of-content)]
### Removed commands [[toc](#table-of-content)]
## Deprecations [[toc](#table-of-content)]
## Removals [[toc](#table-of-content)]
## Other changes [[toc](#table-of-content)]
## Bug fixes [[toc](#table-of-content)]
<!-- NOTE: to start investigating the contributions of last release, i like to list them all in a raw table.
to achieve this, one can use the [`list-merged-prs` script from `nu_scripts`](https://github.com/nushell/nu_scripts/blob/main/make_release/release-note/list-merged-prs)
@ -104,7 +94,6 @@ As usual, new release rhyms with changes to commands!
| last
let prs = list-merged-prs nushell/nushell $last_release_date
| where author != "app/dependabot"
| sort-by mergedAt
| update url {|it| $"[#($it.number)]\(($it.url)\)" }
| update author { $"[@($in)]\(https://github.com/($in)\)" }
@ -116,15 +105,25 @@ As usual, new release rhyms with changes to commands!
```
-->
# Breaking changes [[toc](#table-of-content)]
# All breaking changes [[toc](#table-of-content)]
<!-- TODO:
paste the output of
```nu
./make_release/release-note/list-merged-prs nushell/nushell --label breaking-change --pretty --no-author
./make_release/release-note/list-merged-prs nushell/nushell --label pr:breaking-change --pretty --no-author
```
here
-->
## Notes for plugin developers
# Hall of fame [[toc](#table-of-content)]
Thanks to all the contributors below for helping us solve issues and improve documentation :pray:
| author | title | url |
| ------------------------------------ | ----------- | ------------------------------------------------------- |
| [@author](https://github.com/author) | ... | [#12345](https://github.com/nushell/nushell/pull/12345) |
# Full changelog [[toc](#table-of-content)]
<!-- TODO:
paste the output of