Skip to content

Commit 2e54ec3

Browse files
committed
docs: update release process
1 parent ffba409 commit 2e54ec3

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

docs/release_process.md

+22-13
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
# Torrust Index Release Process (v2.2.2)
1+
# Torrust Index 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,33 @@ 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-index/actions/workflows/deployment.yaml) workflow was successfully executed and the new version for the following crates were published:
71+
72+
- [torrust-index-located-error](https://crates.io/crates/torrust-index-located-error)
73+
- [torrust-index](https://crates.io/crates/torrust-index)
74+
75+
### 7. Create Release on Github from Tag
76+
7077
This is for those who wish to download the source code.
7178

72-
### 8. Stage `main` HEAD for merging into the `develop` branch:
79+
### 8. Stage `main` HEAD for merging into the `develop` branch
80+
7381
Merge release back into the develop branch.
7482

7583
```sh
7684
git fetch --all
7785
git push --force torrust main:staging/develop
7886
```
79-
### 9. Create Comment that bumps next development version:
87+
88+
### 9. Create Comment that bumps next development version
8089

8190
```sh
8291
git stash
@@ -88,7 +97,7 @@ git commit -m "develop: bump to version (next)[semantic version]-develop"
8897
git push torrust
8998
```
9099

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

93102
Pull request title format: "Version `[semantic version]` was Released".
94103

0 commit comments

Comments
 (0)