diff options
| author | Philipp Krones <hello@philkrones.com> | 2023-01-19 11:26:56 +0100 |
|---|---|---|
| committer | Philipp Krones <hello@philkrones.com> | 2023-01-19 11:28:35 +0100 |
| commit | d9baced2b595d52d6927bb4696fa5067c1a427d1 (patch) | |
| tree | 934b1c6ae16eba2ba8daf26f12c0274447825f12 | |
| parent | 89d443a4c3b23d186b07d378b3f1f624cef81055 (diff) | |
| download | rust-d9baced2b595d52d6927bb4696fa5067c1a427d1.tar.gz rust-d9baced2b595d52d6927bb4696fa5067c1a427d1.zip | |
Improve the changelog update documentation
- Make the clippy::version attribute instructions more prominent. - Mention the beta-accepted label.
| -rw-r--r-- | book/src/development/infrastructure/changelog_update.md | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/book/src/development/infrastructure/changelog_update.md b/book/src/development/infrastructure/changelog_update.md index 80a47affe30..d1ac7237b5e 100644 --- a/book/src/development/infrastructure/changelog_update.md +++ b/book/src/development/infrastructure/changelog_update.md @@ -95,11 +95,23 @@ As section headers, we use: Please also be sure to update the Beta/Unreleased sections at the top with the relevant commit ranges. -If you have the time, it would be appreciated if you double-check, that the -`#[clippy::version]` attributes for the added lints contains the correct version. +#### 3.1 Include `beta-accepted` PRs + +Look for the [`beta-accepted`] label and make sure to also include the PRs with +that label in the changelog. If you can, remove the `beta-accepted` labels +**after** the changelog PR was merged. + +> _Note:_ Some of those PRs might even got backported to the previous `beta`. +> Those have to be included in the changelog of the _previous_ release. + +### 4. Update `clippy::version` attributes + +Next, make sure to check that the `#[clippy::version]` attributes for the added +lints contain the correct version. [changelog]: https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md [forge]: https://forge.rust-lang.org/ [rust_master_tools]: https://github.com/rust-lang/rust/tree/master/src/tools/clippy [rust_beta_tools]: https://github.com/rust-lang/rust/tree/beta/src/tools/clippy [rust_stable_tools]: https://github.com/rust-lang/rust/releases +[`beta-accepted`]: https://github.com/rust-lang/rust-clippy/issues?q=label%3Abeta-accepted+ |
