Skip to content

Commit 54aa120

Browse files
authored
Update "Changelog update walkthrough" section (#14785)
Update "Changelog update walkthrough" section based on #14748 discussion changelog: none
2 parents 83248e5 + 2215282 commit 54aa120

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

book/src/development/infrastructure/changelog_update.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ Once you've got the correct commit range, run
5151
util/fetch_prs_between.sh commit1 commit2 > changes.txt
5252
```
5353

54-
and open that file in your editor of choice.
54+
where `commit2` is the commit hash from the previous command and `commit1`
55+
is the commit hash from the current CHANGELOG file.
56+
Open `changes.txt` file in your editor of choice.
5557

5658
When updating the changelog it's also a good idea to make sure that `commit1` is
5759
already correct in the current changelog.
@@ -60,8 +62,8 @@ already correct in the current changelog.
6062

6163
The above script should have dumped all the relevant PRs to the file you
6264
specified. It should have filtered out most of the irrelevant PRs already, but
63-
it's a good idea to do a manual cleanup pass where you look for more irrelevant
64-
PRs. If you're not sure about some PRs, just leave them in for the review and
65+
it's a good idea to do a manual cleanup pass and choose valuable PRs.
66+
If you're not sure about some PRs, just leave them in for the review and
6567
ask for feedback.
6668

6769
With the PRs filtered, you can start to take each PR and move the `changelog: `
@@ -74,10 +76,9 @@ The order should roughly be:
7476
2. Moves or deprecations of lints
7577
3. Changes that expand what code existing lints cover
7678
4. False positive fixes
77-
5. Suggestion fixes/improvements
78-
6. ICE fixes
79-
7. Documentation improvements
80-
8. Others
79+
5. ICE fixes
80+
6. Documentation improvements
81+
7. Others
8182

8283
As section headers, we use:
8384

@@ -91,7 +92,6 @@ As section headers, we use:
9192
9293
### Enhancements
9394
### False Positive Fixes
94-
### Suggestion Fixes/Improvements
9595
### ICE Fixes
9696
### Documentation Improvements
9797
### Others
@@ -112,7 +112,16 @@ that label in the changelog. If you can, remove the `beta-accepted` labels
112112
### 4. Update `clippy::version` attributes
113113

114114
Next, make sure to check that the `#[clippy::version]` attributes for the added
115-
lints contain the correct version.
115+
lints contain the correct version.
116+
In order to find lints that need a version update, go through the lints in the
117+
"New Lints" section and run the following command for each lint name:
118+
119+
```
120+
grep -rB1 "pub $LINT_NAME" .
121+
```
122+
123+
The version shown should match the version of the release the changelog is
124+
written for. If not, update the version to the changelog version.
116125

117126
[changelog]: https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
118127
[forge]: https://forge.rust-lang.org/

0 commit comments

Comments
 (0)