Skip to content

Commit 97ec0ea

Browse files
committed
Update the release process documentation to run xtask publish-release-notes
1 parent f06a29f commit 97ec0ea

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/dev/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Look for `fn benchmark_xxx` tests for a quick way to reproduce performance probl
200200

201201
## Release Process
202202

203-
Release process is handled by `release`, `dist` and `promote` xtasks, `release` being the main one.
203+
Release process is handled by `release`, `dist`, `publish-release-notes` and `promote` xtasks, `release` being the main one.
204204

205205
`release` assumes that you have checkouts of `rust-analyzer`, `rust-analyzer.github.io`, and `rust-lang/rust` in the same directory:
206206

@@ -231,8 +231,9 @@ Release steps:
231231
* create a new changelog in `rust-analyzer.github.io`
232232
3. While the release is in progress, fill in the changelog
233233
4. Commit & push the changelog
234-
5. Tweet
235-
6. Inside `rust-analyzer`, run `cargo xtask promote` -- this will create a PR to rust-lang/rust updating rust-analyzer's subtree.
234+
5. Run `cargo xtask publish-release-notes <CHANGELOG>` -- this will convert the changelog entry in AsciiDoc to Markdown and update the body of GitHub Releases entry.
235+
6. Tweet
236+
7. Inside `rust-analyzer`, run `cargo xtask promote` -- this will create a PR to rust-lang/rust updating rust-analyzer's subtree.
236237
Self-approve the PR.
237238

238239
If the GitHub Actions release fails because of a transient problem like a timeout, you can re-run the job from the Actions console.

0 commit comments

Comments
 (0)