Skip to content

Commit af9a094

Browse files
committed
Auto merge of #5686 - flip1995:release_doc, r=phansch
Reorder sections of release documentation r? @phansch [Rendered](https://github.com/flip1995/rust-clippy/blob/release_doc/doc/release.md) changelog: none
2 parents f61840d + 9ef15ae commit af9a094

File tree

1 file changed

+43
-43
lines changed

1 file changed

+43
-43
lines changed

doc/release.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -7,55 +7,18 @@ Clippy is released together with stable Rust releases. The dates for these
77
releases can be found at the [Rust Forge]. This document explains the necessary
88
steps to create a Clippy release.
99

10-
1. [Find the Clippy commit](#find-the-clippy-commit)
11-
2. [Tag the stable commit](#tag-the-stable-commit)
12-
3. [Update `CHANGELOG.md`](#update-changelogmd)
13-
4. [Remerge the `beta` branch](#remerge-the-beta-branch)
14-
5. [Update the `beta` branch](#update-the-beta-branch)
10+
1. [Remerge the `beta` branch](#remerge-the-beta-branch)
11+
2. [Update the `beta` branch](#update-the-beta-branch)
12+
3. [Find the Clippy commit](#find-the-clippy-commit)
13+
4. [Tag the stable commit](#tag-the-stable-commit)
14+
5. [Update `CHANGELOG.md`](#update-changelogmd)
1515

1616
_NOTE: This document is for stable Rust releases, not for point releases. For
1717
point releases, step 1. and 2. should be enough._
1818

1919
[Rust Forge]: https://forge.rust-lang.org/
2020

2121

22-
## Find the Clippy commit
23-
24-
The first step is to tag the Clippy commit, that is included in the stable Rust
25-
release. This commit can be found in the Rust repository.
26-
27-
```bash
28-
# Assuming the current directory corresponds to the Rust repository
29-
$ git fetch upstream # `upstream` is the `rust-lang/rust` remote
30-
$ git checkout 1.XX.0 # XX should be exchanged with the corresponding version
31-
$ git submodule update
32-
$ SHA=$(git submodule status src/tools/clippy | awk '{print $1}')
33-
```
34-
35-
36-
## Tag the stable commit
37-
38-
After finding the Clippy commit, it can be tagged with the release number.
39-
40-
```bash
41-
# Assuming the current directory corresponds to the Clippy repository
42-
$ git checkout $SHA
43-
$ git tag rust-1.XX.0 # XX should be exchanged with the corresponding version
44-
$ git push upstream master --tags # `upstream` is the `rust-lang/rust-clippy` remote
45-
```
46-
47-
After this, the release should be available on the Clippy [release page].
48-
49-
[release page]: https://github.com/rust-lang/rust-clippy/releases
50-
51-
52-
## Update `CHANGELOG.md`
53-
54-
For this see the document on [how to update the changelog].
55-
56-
[how to update the changelog]: https://github.com/rust-lang/rust-clippy/blob/master/doc/changelog_update.md
57-
58-
5922
## Remerge the `beta` branch
6023

6124
This step is only necessary, if since the last release something was backported
@@ -76,7 +39,7 @@ If this command outputs `master`, this step is **not** necessary.
7639
```bash
7740
# Assuming `HEAD` is the current `master` branch of rust-lang/rust-clippy
7841
$ git checkout -b backport_remerge
79-
$ git merge beta
42+
$ git merge upstream/beta
8043
$ git diff # This diff has to be empty, otherwise something with the remerge failed
8144
$ git push origin backport_remerge # This can be pushed to your fork
8245
```
@@ -109,3 +72,40 @@ $ git checkout beta
10972
$ git rebase $BETA_SHA
11073
$ git push upstream beta
11174
```
75+
76+
77+
## Find the Clippy commit
78+
79+
The first step is to tag the Clippy commit, that is included in the stable Rust
80+
release. This commit can be found in the Rust repository.
81+
82+
```bash
83+
# Assuming the current directory corresponds to the Rust repository
84+
$ git fetch upstream # `upstream` is the `rust-lang/rust` remote
85+
$ git checkout 1.XX.0 # XX should be exchanged with the corresponding version
86+
$ git submodule update
87+
$ SHA=$(git submodule status src/tools/clippy | awk '{print $1}')
88+
```
89+
90+
91+
## Tag the stable commit
92+
93+
After finding the Clippy commit, it can be tagged with the release number.
94+
95+
```bash
96+
# Assuming the current directory corresponds to the Clippy repository
97+
$ git checkout $SHA
98+
$ git tag rust-1.XX.0 # XX should be exchanged with the corresponding version
99+
$ git push upstream master --tags # `upstream` is the `rust-lang/rust-clippy` remote
100+
```
101+
102+
After this, the release should be available on the Clippy [release page].
103+
104+
[release page]: https://github.com/rust-lang/rust-clippy/releases
105+
106+
107+
## Update `CHANGELOG.md`
108+
109+
For this see the document on [how to update the changelog].
110+
111+
[how to update the changelog]: https://github.com/rust-lang/rust-clippy/blob/master/doc/changelog_update.md

0 commit comments

Comments
 (0)