Skip to content

Commit 8abd9fb

Browse files
committed
doc(releasing): Fixing markdown.
Remove unbreakable spaces, and add indentations.
1 parent d5ee644 commit 8abd9fb

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

RELEASING.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,35 +13,36 @@ The procedure is as follows:
1313

1414
1. Switch to a release branch:
1515

16-
```bash
17-
git switch -c release-x.y.z
18-
  ```
16+
```bash
17+
git switch -c release-x.y.z
18+
```
1919

2020
2. Prepare the release. This will update the `README.md`, set the versions in
2121
the `CHANGELOG.md` file, and bump the version in the `Cargo.toml` file.
2222

23-
```bash
24-
cargo xtask release prepare --execute minor|patch|rc
25-
```
23+
```bash
24+
cargo xtask release prepare --execute minor|patch|rc
25+
```
2626

2727
3. Double-check and edit the `CHANGELOG.md` and `README.md` if necessary. Once you are
2828
satisfied, push the branch and open a PR.
2929

30-
```bash
31-
git push --set-upstream origin/release-x.y.z
32-
```
30+
```bash
31+
git push --set-upstream origin/release-x.y.z
32+
```
3333

3434
4. Pass the review and merge the branch as you would with any other branch.
3535

3636
5. Create tags for your new release, publish the release on crates.io and push
3737
the tags:
3838

39-
```bash
40-
# Switch to main first.
41-
git switch main
42-
# Pull in the now-merged release commit(s).
43-
git pull
44-
# Create tags, publish the release on crates.io, and push the tags.
45-
cargo xtask release publish --execute
46-
```
47-
For more information on cargo-release: https://github.com/crate-ci/cargo-release
39+
```bash
40+
# Switch to main first.
41+
git switch main
42+
# Pull in the now-merged release commit(s).
43+
git pull
44+
# Create tags, publish the release on crates.io, and push the tags.
45+
cargo xtask release publish --execute
46+
```
47+
48+
For more information on cargo-release: https://github.com/crate-ci/cargo-release

0 commit comments

Comments
 (0)