Skip to content

Commit 2c84173

Browse files
authored
Update make_release instructions, correct commands (#1203)
1. Update the instructions for making a release and correct the command for creating the next release's PR 2. Correct the command for generating a TOC in the release notes blog post template
1 parent 9f23aeb commit 2c84173

2 files changed

Lines changed: 19 additions & 3 deletions

File tree

make_release/Readme.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# The release process of Nushell
2+
3+
There are two threads you can do in parallel: publishing crates and generating release notes. The former can be done the day of, but it's best to start the latter a few days early.
4+
25
## 0. Release direct dependencies
36
> **Note**
47
> the following procedure is the same for `nu-ansi-term` and `reedline` and needs to be repeated
@@ -73,6 +76,15 @@
7376
7477
## 4. Publish the release notes on the website
7578
79+
- [ ] Go through all the PRs that may have incorrect release notes or labels and either correct them yourself or ask the author to do so. It's best to finish doing this before you generate the release notes PR, so that the PR is generated correctly.
80+
```nu
81+
use /path/to/nu_scripts/make_release/notes
82+
notes check-prs v?.???.?
83+
```
84+
- [ ] If it doesn't exist already, generate the release notes PR in the [nushell.github.io](https://github.com/nushell/nushell.github.io) repo:
85+
```nu
86+
nu /path/to/nu_scripts/make_release/notes/create-pr.nu v0.xxx.0 (date now)
87+
```
7688
- [ ] follow and finish the TODOs in the release notes file
7789
- [ ] mark as ready for review when uploading to crates.io
7890
- [ ] land when
@@ -83,14 +95,18 @@
8395
- [ ] go to the draft release on the [release page](https://github.com/nushell/nushell/releases)
8496
- [ ] grab the message of [last one](https://github.com/nushell/nushell/releases/latest)
8597
- [ ] wait for the website to publish the release (in the [actions](https://github.com/nushell/nushell.github.io/actions) tab and on the [website](https://www.nushell.sh/blog/))
98+
- [ ] fill in the release notes using the `gh-release-excerpt.nu` script:
99+
```nu
100+
nu /path/to/nu_scripts/make_release/notes/gh-release-excerpt.nu <version> <blog post url> <prev release date>
101+
```
86102
- [ ] publish the release on *GitHub*
87103

88104
## 6. social media
89105
- [ ] post a status update on Discord
90106
- [ ] tweet about the new release
91107

92-
## 7. Create the next release note PR on the website
93-
- [ ] run `./make_release/release-note/create-pr 0.xx.0 ((date now) + 4wk | format date "%Y-%m-%d" | into datetime)`
108+
## 7. Create the next release note PR on the website (optional)
109+
- [ ] run `./make_release/notes/create-pr v0.xx.0 ((date now) + 6wk | format date "%Y-%m-%d" | into datetime)`
94110

95111
## 8. Bump the version as development
96112
- [ ] bump the patch version on [`nushell`] ([example][nushell dev example]) by running

make_release/notes/template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ As part of this release, we also publish a set of optional [plugins](https://www
2424

2525
# Table of contents
2626

27-
<!-- TODO: once all the content below is finished and committed, `use nu_scripts/make_release/release-note/notes.nu *` and run `write-toc $this_file`. -->
27+
<!-- TODO: once all the content below is finished and committed, `use nu_scripts/make_release/release-note/notes *` and run `write-toc $this_file`. -->
2828

2929
# Highlights and themes of this release
3030

0 commit comments

Comments
 (0)