Skip to content

Commit

Permalink
Auto merge of rust-lang#8636 - flip1995:release_changelog_quick_updat…
Browse files Browse the repository at this point in the history
…e, r=xFrednet

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.

[Rendered](https://github.com/flip1995/rust-clippy/blob/release_changelog_quick_update/doc/release.md)

changelog: none
  • Loading branch information
bors committed Apr 5, 2022
2 parents 938b9fd + f8c2e6d commit 9a09506
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions doc/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 9a09506

Please sign in to comment.