Skip to content

Commit 9a09506

Browse files
committed
Auto merge of #8636 - flip1995:release_changelog_quick_update, 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
2 parents 938b9fd + f8c2e6d commit 9a09506

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

doc/release.md

+21
Original file line numberDiff line numberDiff line change
@@ -121,4 +121,25 @@ happened a stable backport, make sure to re-merge those changes just as with the
121121

122122
For this see the document on [how to update the changelog].
123123

124+
If you don't have time to do a complete changelog update right away, just update
125+
the following parts:
126+
127+
- Remove the `(beta)` from the new stable version:
128+
129+
```markdown
130+
## Rust 1.XX (beta) -> ## Rust 1.XX
131+
```
132+
133+
- Update the release date line of the new stable version:
134+
135+
```markdown
136+
Current beta, release 20YY-MM-DD -> Current stable, released 20YY-MM-DD
137+
```
138+
139+
- Update the release date line of the previous stable version:
140+
141+
```markdown
142+
Current stable, released 20YY-MM-DD -> Released 20YY-MM-DD
143+
```
144+
124145
[how to update the changelog]: https://github.com/rust-lang/rust-clippy/blob/master/doc/changelog_update.md

0 commit comments

Comments
 (0)