diff --git a/make_release/Readme.md b/make_release/Readme.md index c061d3aa..c6c9135a 100644 --- a/make_release/Readme.md +++ b/make_release/Readme.md @@ -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* diff --git a/make_release/release-note/template.md b/make_release/release-note/template.md index 5901ac36..dbcc2305 100644 --- a/make_release/release-note/template.md +++ b/make_release/release-note/template.md @@ -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_`. # 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) -- [*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)] -## 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)] -# Breaking changes [[toc](#table-of-content)] +# All breaking changes [[toc](#table-of-content)] +## 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)]