Skip to content

Commit 14544d1

Browse files
committed
Document the change
1 parent 7bc384f commit 14544d1

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

book/src/development/infrastructure/changelog_update.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,29 @@ and open that file in your editor of choice.
5656
When updating the changelog it's also a good idea to make sure that `commit1` is
5757
already correct in the current changelog.
5858

59+
#### From commit range to PR link
60+
61+
Raw commit ranges aren't used, they aren't very useful or illustrative, so we developed the concept of PR ranges to help the user understand the size of a new update.
62+
63+
To create a PR range, get the current release date and the date that the last version was released (YYYY-MM-DD) and use the following link:
64+
65+
```
66+
[**View <NUMBER OF PRs> PRs merged since 1.<LAST VERSION NUM>**](https://github.com/rust-lang/rust-clippy/pulls?q=is%3Apr+is%3Aclosed+merged%3A<LAST VERSION DATE>..<CURRENT VERSION DATE>+base%3Amaster+sort%3Amerged-desc+)
67+
```
68+
69+
> Note: Be sure to check click the link and check how many PRs got merged between
70+
71+
Example:
72+
73+
```
74+
[**View 85 PRs merged since 1.69**](https://github.com/rust-lang/rust-clippy/pulls?q=is%3Apr+is%3Aclosed+merged%3A2023-04-20..2023-06-01+base%3Amaster+sort%3Amerged-desc+)
75+
```
76+
77+
Which renders to:
78+
[**View 85 PRs merged since 1.69**](https://github.com/rust-lang/rust-clippy/pulls?q=is%3Apr+is%3Aclosed+merged%3A2023-04-20..2023-06-01+base%3Amaster+sort%3Amerged-desc+)
79+
80+
Note that **commit ranges should not be included**, only PR ranges.
81+
5982
### 3. Authoring the final changelog
6083

6184
The above script should have dumped all the relevant PRs to the file you

0 commit comments

Comments
 (0)