Skip to content

Commit

Permalink
Merge #391: Copy release process docs from Tracker
Browse files Browse the repository at this point in the history
af88bae docs: [#371] copy release process docs from Tracker (Jose Celano)

Pull request description:

  Copy release process docs from Tracker.

ACKs for top commit:
  josecelano:
    ACK af88bae

Tree-SHA512: 54210570826e77303b81f5e076effcae64b91200fe0a92252408a1a55c8f750f3034ba3ec5aa76843bdd2583ff177cc16d2598a2c486380019c7da3bd2b69a70
  • Loading branch information
josecelano committed Nov 29, 2023
2 parents bae9ac2 + af88bae commit 1ec2f13
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
- [Run the backend](#run-the-backend)
- [Run the Index GUI](#run-the-index-gui)
- [Testing](#testing)
- [Containers](#containers)
- [Containers](#containers)
- [Release process](#containers)

## User guide

Expand Down Expand Up @@ -330,3 +331,7 @@ If you want to contribute please read the [Cypress Best Practices](https://docs.
## Containers

Please refer to the [Containers](./containers.md) section for more information about containers.

## Release process

Please refer to the [Release process](./release_process.md) section for more information about the release process.
99 changes: 99 additions & 0 deletions docs/release_process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Torrust Index GUI Release Process (v2.2.2)

## Version

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

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

```sh
git remote show torrust
```

```s
* remote torrust
Fetch URL: [email protected]:torrust/torrust-index-gui.git
Push URL: [email protected]:torrust/torrust-index-gui.git
...
```

### 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

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

### 3. Create Release Commit

```sh
git stash
git switch staging/main
git reset --hard torrust/staging/main
# change `[semantic version]-develop` to `[semantic version]`.
git add -A
git commit -m "release: version [semantic version]"
git push torrust
```

### 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

```sh
git fetch --all
git push torrust main:releases/v[semantic version]
```

> **Check that the deployment is successful!**
### 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

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

### 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

```sh
git stash
git switch staging/develop
git reset --hard torrust/staging/develop
# change `[semantic version]` to `(next)[semantic version]-develop`.
git add -A
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.

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

This pull request merges the new release into the `develop` branch and bumps the version number.

0 comments on commit 1ec2f13

Please sign in to comment.