Skip to content

Commit ab0dd30

Browse files
committed
docs: update release process
1 parent a005af2 commit ab0dd30

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

docs/release_process.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
1-
# Torrust Tracker Release Process (draft)
1+
# Torrust Tracker Release Process (draft 2)
22

33
The purpose of this document is to describe the release process.
44

55
## Overview
66

7-
Torrust Tracker is published in this order:
7+
Torrust Tracker is published according to this protocol:
88

9-
1. `develop` branch is ready for publishing.
10-
2. create `release: version (semantic version)` commit.
11-
3. push release commit to `main` branch.
12-
4. check all status checks succeed for `main` branch.
13-
5. push `main` branch to `releases\v(semantic version)` branch.
14-
6. check all status checks success for `releases\v(semantic version)` branch.
15-
7. create signed `v(semantic version)` tag.
16-
8. create github release from `v(semantic version)` tag.
17-
9. merge `main` branch into `develop` branch.
9+
0. After release create new pull request into `develop` branch:
10+
11+
- The `develop` branch has the (semantic version) suffix `-develop`.
12+
- The version is bumped according to releases, new features, and breaking changes.
13+
14+
- [ ] `develop` is ready for branching for a release.
15+
- [ ] force-push develop to `staging` branch.
16+
- [ ] commit `release: version (semantic version)`, removing the `-develop` suffix.
17+
- [ ] create pull request to merge `staging` into `main` branch.
18+
- [ ] check all status checks succeed for `main` branch.
19+
- [ ] push `main` branch to `releases\v(semantic version)` branch.
20+
- [ ] check all status checks success for `releases\v(semantic version)` branch.
21+
- [ ] create signed `v(semantic version)` tag from `releases\v(semantic version) HEAD`.
22+
- [ ] create github release from `v(semantic version)` tag.
23+
- [ ] merge the `main` branch back into `develop` branch, assuring that the (semantic version) has the suffix `-develop`.
1824

1925
- At step `1.`, `develop` is automatically published to `dockerhub`.
2026
- At step `3.`, `main` is automatically published to `dockerhub`.
21-
- At step `5.`, `releases\v(semantic version)` is automatically published to `dockerhub` and `crate.io`.
27+
- At step `6.`, `releases\v(semantic version)` is automatically published to `dockerhub` and `crate.io`.
2228

2329
## Development Branch
2430

0 commit comments

Comments
 (0)