From f8c2e6dc4eee2ad42fcdab0eb0bb321b6b9e60ac Mon Sep 17 00:00:00 2001 From: flip1995 Date: Tue, 5 Apr 2022 10:24:32 +0100 Subject: [PATCH] Add documentation on how to do a minimal changelog update This ensures that the link to the Clippy version in the Rust release blog post works correctly. The additional `(beta)` behind the previous beta version breaks that link otherwise. --- doc/release.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/release.md b/doc/release.md index afe3033c288..c4f8f989384 100644 --- a/doc/release.md +++ b/doc/release.md @@ -121,4 +121,25 @@ happened a stable backport, make sure to re-merge those changes just as with the For this see the document on [how to update the changelog]. +If you don't have time to do a complete changelog update right away, just update +the following parts: + +- Remove the `(beta)` from the new stable version: + + ```markdown + ## Rust 1.XX (beta) -> ## Rust 1.XX + ``` + +- Update the release date line of the new stable version: + + ```markdown + Current beta, release 20YY-MM-DD -> Current stable, released 20YY-MM-DD + ``` + +- Update the release date line of the previous stable version: + + ```markdown + Current stable, released 20YY-MM-DD -> Released 20YY-MM-DD + ``` + [how to update the changelog]: https://github.com/rust-lang/rust-clippy/blob/master/doc/changelog_update.md