about summary refs log tree commit diff
path: root/docs/dev
diff options
context:
space:
mode:
authorNoritada Kobayashi <noritada.kobayashi@gmail.com>2022-12-12 02:09:31 +0900
committerNoritada Kobayashi <noritada.kobayashi@gmail.com>2022-12-12 02:09:31 +0900
commit97ec0ea698cbfeb7a0f62d0cd270050194c95c5d (patch)
tree9bf012c54ea081a7c98b10cca1d58f3fa220eee3 /docs/dev
parentf06a29f6e1fed49c0e817e669b77f3110ef84d6c (diff)
downloadrust-97ec0ea698cbfeb7a0f62d0cd270050194c95c5d.tar.gz
rust-97ec0ea698cbfeb7a0f62d0cd270050194c95c5d.zip
Update the release process documentation to run `xtask publish-release-notes`
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index 4ac75b4bbfd..cdab6b09928 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -200,7 +200,7 @@ Look for `fn benchmark_xxx` tests for a quick way to reproduce performance probl
 
 ## Release Process
 
-Release process is handled by `release`, `dist` and `promote` xtasks, `release` being the main one.
+Release process is handled by `release`, `dist`, `publish-release-notes` and `promote` xtasks, `release` being the main one.
 
 `release` assumes that you have checkouts of `rust-analyzer`, `rust-analyzer.github.io`, and `rust-lang/rust` in the same directory:
 
@@ -231,8 +231,9 @@ Release steps:
    * create a new changelog in `rust-analyzer.github.io`
 3. While the release is in progress, fill in the changelog
 4. Commit & push the changelog
-5. Tweet
-6. Inside `rust-analyzer`, run `cargo xtask promote` -- this will create a PR to rust-lang/rust updating rust-analyzer's subtree.
+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.
+6. Tweet
+7. Inside `rust-analyzer`, run `cargo xtask promote` -- this will create a PR to rust-lang/rust updating rust-analyzer's subtree.
    Self-approve the PR.
 
 If the GitHub Actions release fails because of a transient problem like a timeout, you can re-run the job from the Actions console.