1
- # Torrust Tracker Release Process (v2.2.2)
1
+ # Torrust Tracker Release Process (v2.2.2)
2
+
3
+ ## Version
2
4
3
- ## Version:
4
5
> ** The ` [semantic version] ` is bumped according to releases, new features, and breaking changes.**
5
6
>
6
7
> * The ` develop ` branch uses the (semantic version) suffix ` -develop ` .*
7
8
8
- ## Process:
9
+ ## Process
9
10
10
11
** Note** : this guide assumes that the your git ` torrust ` remote is like this:
11
12
@@ -20,18 +21,18 @@ git remote show torrust
20
21
...
21
22
```
22
23
24
+ ### 1. The ` develop ` branch is ready for a release
23
25
24
- ### 1. The ` develop ` branch is ready for a release.
25
26
The ` develop ` branch should have the version ` [semantic version]-develop ` that is ready to be released.
26
27
27
- ### 2. Stage ` develop ` HEAD for merging into the ` main ` branch:
28
+ ### 2. Stage ` develop ` HEAD for merging into the ` main ` branch
28
29
29
30
``` sh
30
31
git fetch --all
31
32
git push --force torrust develop:staging/main
32
33
```
33
34
34
- ### 3. Create Release Commit:
35
+ ### 3. Create Release Commit
35
36
36
37
``` sh
37
38
git stash
@@ -43,13 +44,13 @@ git commit -m "release: version [semantic version]"
43
44
git push torrust
44
45
```
45
46
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
47
48
48
49
Pull request title format: "Release Version ` [semantic version] ` ".
49
50
50
51
This pull request merges the new version into the ` main ` branch.
51
52
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
53
54
54
55
``` sh
55
56
git fetch --all
@@ -58,25 +59,39 @@ git push torrust main:releases/v[semantic version]
58
59
59
60
> ** Check that the deployment is successful!**
60
61
61
- ### 6. Create Release Tag:
62
+ ### 6. Create Release Tag
62
63
63
64
``` sh
64
65
git switch releases/v[semantic version]
65
66
git tag --sign v[semantic version]
66
67
git push --tags torrust
67
68
```
68
69
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
+
70
83
This is for those who wish to download the source code.
71
84
72
- ### 8. Stage ` main ` HEAD for merging into the ` develop ` branch:
85
+ ### 8. Stage ` main ` HEAD for merging into the ` develop ` branch
86
+
73
87
Merge release back into the develop branch.
74
88
75
89
``` sh
76
90
git fetch --all
77
91
git push --force torrust main:staging/develop
78
92
```
79
- ### 9. Create Comment that bumps next development version:
93
+
94
+ ### 9. Create Comment that bumps next development version
80
95
81
96
``` sh
82
97
git stash
@@ -88,7 +103,7 @@ git commit -m "develop: bump to version (next)[semantic version]-develop"
88
103
git push torrust
89
104
```
90
105
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
92
107
93
108
Pull request title format: "Version ` [semantic version] ` was Released".
94
109
0 commit comments