@@ -14,28 +14,34 @@ Forge][forge].
14
14
Most of the time we only need to update the changelog for minor Rust releases. It's
15
15
been very rare that Clippy changes were included in a patch release.
16
16
17
- ## How to update
17
+ ## Changelog update walkthrough
18
18
19
19
### 1. Finding the relevant Clippy commits
20
20
21
21
Each Rust release ships with its own version of Clippy. The Clippy submodule can
22
- be found in the [ tools] [ tools ] directory of the Rust repository.
22
+ be found in the ` tools ` directory of the Rust repository.
23
23
24
- To find the Clippy commit hash for a specific Rust release you select the Rust
25
- release tag from the dropdown and then check the commit of the Clippy directory :
24
+ Depending on the current time and what exactly you want to update, the following
25
+ bullet points might be helpful :
26
26
27
- ![ Explanation of how to find the commit hash] ( https://user-images.githubusercontent.com/2042399/62846160-1f8b0480-bcce-11e9-9da8-7964ca034e7a.png )
27
+ * When writing the release notes for the ** upcoming stable release** you need to check
28
+ out the Clippy commit of the current Rust ` beta ` branch. [ Link] [ rust_beta_tools ]
29
+ * When writing the release notes for the ** upcoming beta release** , you need to check
30
+ out the Clippy commit of the current Rust ` master ` . [ Link] [ rust_master_tools ]
31
+ * When writing the (forgotten) release notes for a ** past stable release** , you
32
+ need to select the Rust release tag from the dropdown and then check the
33
+ commit of the Clippy directory:
34
+
35
+ ![ Explanation of how to find the commit hash] ( https://user-images.githubusercontent.com/2042399/62846160-1f8b0480-bcce-11e9-9da8-7964ca034e7a.png )
28
36
29
- When writing the release notes for the upcoming stable release you want to check
30
- out the commit of the current Rust ` beta ` tag.
31
37
32
38
### 2. Fetching the PRs between those commits
33
39
34
- You'll want to run ` util/fetch_prs_between.sh commit1 commit2 > changes.txt `
35
- and open that file in your editor of choice.
40
+ Once you've got the correct commit range, run
36
41
37
- * ` commit1 ` is the Clippy commit hash of the previous stable release
38
- * ` commit2 ` is the Clippy commit hash of the release you want to write the changelog for.
42
+ util/fetch_prs_between.sh commit1 commit2 > changes.txt
43
+
44
+ and open that file in your editor of choice.
39
45
40
46
When updating the changelog it's also a good idea to make sure that ` commit1 ` is
41
47
already correct in the current changelog.
@@ -68,4 +74,5 @@ relevant commit ranges.
68
74
69
75
[ changelog ] : https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
70
76
[ forge ] : https://forge.rust-lang.org/
71
- [ tools ] : https://github.com/rust-lang/rust/tree/master/src/tools
77
+ [ rust_master_tools ] : https://github.com/rust-lang/rust/tree/master/src/tools
78
+ [ rust_beta_tools ] : https://github.com/rust-lang/rust/tree/beta/src/tools
0 commit comments