Skip to content

Commit

Permalink
Merge #748: docs: update release process
Browse files Browse the repository at this point in the history
2e54ec3 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 2e54ec3

Tree-SHA512: 3276fde4f3c8852ba305eb1d716ba555b07ecdf2365a09ebbcec9ec6963d914a016723a719b7ccabe013f467488450d5fec99f9354d61914c8ffcf32c3cba855
  • Loading branch information
josecelano committed Oct 26, 2024
2 parents ffba409 + 2e54ec3 commit 91a0b76
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions docs/release_process.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Torrust Index Release Process (v2.2.2)
# Torrust Index Release Process (v2.2.2)

## Version

## Version:
> **The `[semantic version]` is bumped according to releases, new features, and breaking changes.**
>
> *The `develop` branch uses the (semantic version) suffix `-develop`.*
## Process:
## Process

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

Expand All @@ -20,18 +21,18 @@ git remote show torrust
...
```

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

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

### 2. Stage `develop` HEAD for merging into the `main` branch:
### 2. Stage `develop` HEAD for merging into the `main` branch

```sh
git fetch --all
git push --force torrust develop:staging/main
```

### 3. Create Release Commit:
### 3. Create Release Commit

```sh
git stash
Expand All @@ -43,13 +44,13 @@ git commit -m "release: version [semantic version]"
git push torrust
```

### 4. Create and Merge Pull Request from `staging/main` into `main` branch.
### 4. Create and Merge Pull Request from `staging/main` into `main` branch

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

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

### 5. Push new version from `main` HEAD to `releases/v[semantic version]` branch:
### 5. Push new version from `main` HEAD to `releases/v[semantic version]` branch

```sh
git fetch --all
Expand All @@ -58,25 +59,33 @@ git push torrust main:releases/v[semantic version]

> **Check that the deployment is successful!**
### 6. Create Release Tag:
### 6. Create Release Tag

```sh
git switch releases/v[semantic version]
git tag --sign v[semantic version]
git push --tags torrust
```

### 7. Create Release on Github from Tag.
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:

- [torrust-index-located-error](https://crates.io/crates/torrust-index-located-error)
- [torrust-index](https://crates.io/crates/torrust-index)

### 7. Create Release on Github from Tag

This is for those who wish to download the source code.

### 8. Stage `main` HEAD for merging into the `develop` branch:
### 8. Stage `main` HEAD for merging into the `develop` branch

Merge release back into the develop branch.

```sh
git fetch --all
git push --force torrust main:staging/develop
```
### 9. Create Comment that bumps next development version:

### 9. Create Comment that bumps next development version

```sh
git stash
Expand All @@ -88,7 +97,7 @@ git commit -m "develop: bump to version (next)[semantic version]-develop"
git push torrust
```

### 10. Create and Merge Pull Request from `staging/develop` into `develop` branch.
### 10. Create and Merge Pull Request from `staging/develop` into `develop` branch

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

Expand Down

0 comments on commit 91a0b76

Please sign in to comment.