Skip to content

Commit 36e3e26

Browse files
committed
Auto merge of #10213 - flip1995:changelog-doc, r=xFrednet
Improve the changelog update documentation - Make the clippy::version attribute instructions more prominent. - Mention the beta-accepted label. [Rendered](https://github.com/flip1995/rust-clippy/blob/changelog-doc/book/src/development/infrastructure/changelog_update.md) r? `@xFrednet` changelog: none
2 parents 89d443a + d9baced commit 36e3e26

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

book/src/development/infrastructure/changelog_update.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,23 @@ As section headers, we use:
9595
Please also be sure to update the Beta/Unreleased sections at the top with the
9696
relevant commit ranges.
9797

98-
If you have the time, it would be appreciated if you double-check, that the
99-
`#[clippy::version]` attributes for the added lints contains the correct version.
98+
#### 3.1 Include `beta-accepted` PRs
99+
100+
Look for the [`beta-accepted`] label and make sure to also include the PRs with
101+
that label in the changelog. If you can, remove the `beta-accepted` labels
102+
**after** the changelog PR was merged.
103+
104+
> _Note:_ Some of those PRs might even got backported to the previous `beta`.
105+
> Those have to be included in the changelog of the _previous_ release.
106+
107+
### 4. Update `clippy::version` attributes
108+
109+
Next, make sure to check that the `#[clippy::version]` attributes for the added
110+
lints contain the correct version.
100111

101112
[changelog]: https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
102113
[forge]: https://forge.rust-lang.org/
103114
[rust_master_tools]: https://github.com/rust-lang/rust/tree/master/src/tools/clippy
104115
[rust_beta_tools]: https://github.com/rust-lang/rust/tree/beta/src/tools/clippy
105116
[rust_stable_tools]: https://github.com/rust-lang/rust/releases
117+
[`beta-accepted`]: https://github.com/rust-lang/rust-clippy/issues?q=label%3Abeta-accepted+

0 commit comments

Comments
 (0)