Merge torrust#748: docs: update release process

22be10d 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.

Top commit has no ACKs.

Tree-SHA512: 52e41b75dc281431879c8b796b5d407ffdb2278536f6e413c1f45e6537a9a02f8635ed127f28dce1c369e8e948abe8921791e649f8479bf1a6f7df08b104e8e3

docs/release_process.md

@@ -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:
 
@@ -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
@@ -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
@@ -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
@@ -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".