Skip to content

Commit cb9e345

Browse files
committed
Merge torrust#1062: docs: update release process
c9f4dfd docs: update release process (Jose Celano) Pull request description: I've updated the release process. The process is the same, so I didn't bump the version. I just added a new check because I didn't realise in the recent releases that the deployment workflow failed. I've also fixed markdown linter errors. ACKs for top commit: josecelano: ACK c9f4dfd Tree-SHA512: b3fedb1863bf7d0945987bd0bba8430b925518a4a73f551b69620b02dff5d65792d073c63a3c4e496863047b3fba949b2fdcee23555923b35922df97642dbcd7
2 parents ab9f6e0 + c9f4dfd commit cb9e345

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

docs/release_process.md

+28-13
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
# Torrust Tracker Release Process (v2.2.2)
1+
# Torrust Tracker Release Process (v2.2.2)
2+
3+
## Version
24

3-
## Version:
45
> **The `[semantic version]` is bumped according to releases, new features, and breaking changes.**
56
>
67
> *The `develop` branch uses the (semantic version) suffix `-develop`.*
78
8-
## Process:
9+
## Process
910

1011
**Note**: this guide assumes that the your git `torrust` remote is like this:
1112

@@ -20,18 +21,18 @@ git remote show torrust
2021
...
2122
```
2223

24+
### 1. The `develop` branch is ready for a release
2325

24-
### 1. The `develop` branch is ready for a release.
2526
The `develop` branch should have the version `[semantic version]-develop` that is ready to be released.
2627

27-
### 2. Stage `develop` HEAD for merging into the `main` branch:
28+
### 2. Stage `develop` HEAD for merging into the `main` branch
2829

2930
```sh
3031
git fetch --all
3132
git push --force torrust develop:staging/main
3233
```
3334

34-
### 3. Create Release Commit:
35+
### 3. Create Release Commit
3536

3637
```sh
3738
git stash
@@ -43,13 +44,13 @@ git commit -m "release: version [semantic version]"
4344
git push torrust
4445
```
4546

46-
### 4. Create and Merge Pull Request from `staging/main` into `main` branch.
47+
### 4. Create and Merge Pull Request from `staging/main` into `main` branch
4748

4849
Pull request title format: "Release Version `[semantic version]`".
4950

5051
This pull request merges the new version into the `main` branch.
5152

52-
### 5. Push new version from `main` HEAD to `releases/v[semantic version]` branch:
53+
### 5. Push new version from `main` HEAD to `releases/v[semantic version]` branch
5354

5455
```sh
5556
git fetch --all
@@ -58,25 +59,39 @@ git push torrust main:releases/v[semantic version]
5859

5960
> **Check that the deployment is successful!**
6061
61-
### 6. Create Release Tag:
62+
### 6. Create Release Tag
6263

6364
```sh
6465
git switch releases/v[semantic version]
6566
git tag --sign v[semantic version]
6667
git push --tags torrust
6768
```
6869

69-
### 7. Create Release on Github from Tag.
70+
Make sure the [deployment](https://github.com/torrust/torrust-tracker/actions/workflows/deployment.yaml) workflow was successfully executed and the new version for the following crates were published:
71+
72+
- [torrust-tracker-contrib-bencode](https://crates.io/crates/torrust-tracker-contrib-bencode)
73+
- [torrust-tracker-located-error](https://crates.io/crates/torrust-tracker-located-error)
74+
- [torrust-tracker-primitives](https://crates.io/crates/torrust-tracker-primitives)
75+
- [torrust-tracker-clock](https://crates.io/crates/torrust-tracker-clock)
76+
- [torrust-tracker-configuration](https://crates.io/crates/torrust-tracker-configuration)
77+
- [torrust-tracker-torrent-repository](https://crates.io/crates/torrust-tracker-torrent-repository)
78+
- [torrust-tracker-test-helpers](https://crates.io/crates/torrust-tracker-test-helpers)
79+
- [torrust-tracker](https://crates.io/crates/torrust-tracker)
80+
81+
### 7. Create Release on Github from Tag
82+
7083
This is for those who wish to download the source code.
7184

72-
### 8. Stage `main` HEAD for merging into the `develop` branch:
85+
### 8. Stage `main` HEAD for merging into the `develop` branch
86+
7387
Merge release back into the develop branch.
7488

7589
```sh
7690
git fetch --all
7791
git push --force torrust main:staging/develop
7892
```
79-
### 9. Create Comment that bumps next development version:
93+
94+
### 9. Create Comment that bumps next development version
8095

8196
```sh
8297
git stash
@@ -88,7 +103,7 @@ git commit -m "develop: bump to version (next)[semantic version]-develop"
88103
git push torrust
89104
```
90105

91-
### 10. Create and Merge Pull Request from `staging/develop` into `develop` branch.
106+
### 10. Create and Merge Pull Request from `staging/develop` into `develop` branch
92107

93108
Pull request title format: "Version `[semantic version]` was Released".
94109

0 commit comments

Comments
 (0)