Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 0c05a21

Browse files
scampitopecongiro
authored andcommitted
Document some additional points about maintaining rustfmt (rust-lang#3579)
1 parent a7d4ec9 commit 0c05a21

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

Processes.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ In this Section, we describe how to stabilise an option of the rustfmt's configr
66

77
## Conditions
88

9+
- Is the default value correct ?
910
- The design and implementation of the option are sound and clean.
1011
- The option is well tested, both in unit tests and, optimally, in real usage.
1112
- There is no open bug about the option that prevents its use.
@@ -20,3 +21,36 @@ Open a pull request that closes the tracking issue. The tracking issue is listed
2021
## After the stabilisation
2122

2223
The option should remain backward-compatible with previous parameters of the option. For instance, if the option is an enum `enum Foo { Alice, Bob }` and the variant `Foo::Bob` is removed/renamed, existing use of the `Foo::Bob` variant should map to the new logic. Breaking changes can be applied under the condition they are version-gated.
24+
25+
# Make a Release
26+
27+
## 0. Update CHANGELOG.md
28+
29+
## 1. Update Cargo.toml and Cargo.lock
30+
31+
For example, 1.0.0 -> 1.0.1:
32+
33+
```diff
34+
-version = "1.0.0"
35+
+version = "1.0.1"
36+
```
37+
38+
## 2. Push the commit to the master branch
39+
40+
E.g., https://github.com/rust-lang/rustfmt/commit/5274b49caa1a7db6ac10c76bf1a3d5710ccef569
41+
42+
## 3. Create a release tag
43+
44+
```sh
45+
git tag -s v1.2.3 -m "Release 1.2.3"
46+
```
47+
48+
## 4. Publish to crates.io
49+
50+
`cargo publish`
51+
52+
## 5. Create a PR to rust-lang/rust to update the rustfmt submodule
53+
54+
Note that if you are updating `rustc-ap-*` crates, then you need to update **every** submodules in the rust-lang/rust repository that depend on the crates to use the same version of those.
55+
56+
As of 2019/05, there are two such crates: `rls` and `racer` (`racer` depends on `rustc-ap-syntax` and `rls` depends on `racer`, and `rls` is one of submodules of the rust-lang/rust repository).

0 commit comments

Comments
 (0)