Skip to content
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

Edit release notes template #853

Merged
merged 11 commits into from
May 28, 2024
Prev Previous commit
Next Next commit
Reorganize and rename changes section
  • Loading branch information
IanManske committed May 27, 2024
commit d861b476747753e7199091f074d076179e6fbdf6
34 changes: 21 additions & 13 deletions make_release/release-note/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,13 @@ As part of this release, we also publish a set of optional plugins you can insta
- [*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)
- [*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)
<!-- TODO: please add links to the other sections here

the following command should help pre-generate a great deal of the table of content.
Expand All @@ -45,7 +47,7 @@ As part of this release, we also publish a set of optional plugins you can insta
| to text
```
-->
- [*Breaking changes*](#breaking-changes-toc)
- [*All breaking changes*](#all-breaking-changes-toc)
- [*Full changelog*](#full-changelog-toc)

# Highlights and themes of this release [[toc](#table-of-content)]
Expand Down Expand Up @@ -76,13 +78,19 @@ Thanks to all the contributors below for helping us making the documentation of
| ------------------------------------ | ----------- | ------------------------------------------------------- |
| [@author](https://github.com/author) | ... | [#12345](https://github.com/nushell/nushell/pull/12345) |

# Our set of commands is evolving [[toc](#table-of-content)]
As usual, new release rhyms with changes to commands!
# Changes to commands [[toc](#table-of-content)]

## Additions [[toc](#table-of-content)]

## Breaking changes [[toc](#table-of-content)]

## Deprecations [[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)]
## 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)
Expand Down Expand Up @@ -112,7 +120,7 @@ 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
Expand Down