Merge #48: docs: add release process

8e7e8fa docs: add release process (Jose Celano)

Pull request description:

  Add documentation for the release process. It's just the current process I'm following when I publish a new version. It does not mean we should continue doing it this way. I just only wanted to make it public.

ACKs for top commit:
  josecelano:
    ACK 8e7e8fa

Tree-SHA512: 616d8b6ccc4a3f9e2c493480766a10ca53a9d225f34beb69abfc0627b18ed77c2f54972fc789840675701bb86a5609af652cbd0dd0b34b35ffffb8ae18bb4ad6

Author: josecelano

docs/release_process.md

@@ -0,0 +1,82 @@
+# Release Process (v1.0.0)
+
+## Version
+
+> **The `[semantic version]` is bumped according to releases, new features, and breaking changes.**
+>
+> *The `main` branch uses the semantic version of the last released version.
+
+## 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-api-lib.git
+  Push  URL: [email protected]:torrust/torrust-index-api-lib.git
+...
+```
+
+### 1. The `main` branch is ready for a release
+
+```sh
+npm install && npm run build
+```
+
+There should be no errors installing or building the library.
+
+### 2. Change the version in the `package.json` file
+
+Change the version in the `package.json` file. For example `3.0.0`.
+
+> NOTICE: The `v` prefix is not needed.
+
+Install and build to double-check:
+
+```sh
+npm install && npm run build
+```
+
+Commit the changes:
+
+```sh
+git add -A
+git commit -m "feat: release [semantic version]"
+```
+
+### 3. Create a new tag an push to the remote
+
+```sh
+git tag v[semantic version]
+git push torrust && git push torrust v[semantic version]
+```
+
+For example:
+
+```sh
+git tag v3.0.0
+git push torrust && git push torrust v3.0.0
+```
+
+### 4. Manually publish the NPM package
+
+```sh
+npm publish
+```
+
+> IMPORTANT:
+>
+> - You will require to login.
+> - You have to have permission for publishing on the Torrust namespace.
+
+If you get an error because you were not logged in, just retry the same command after the login.
+
+### 4. Check the package is published
+
+You should receive an email when the package is published.
+
+You can also check on the NPM registry: <https://www.npmjs.com/package/torrust-index-api-lib>.