Files

lebaudantoine b604235c35 📝(release) document releasing new version

Heavily inspired from openfun handbook instructions,
https://handbook.openfun.fr/git

Document how release a new version. Might be a common
documentation shared with Impress, Regie and Meet projects.
Let's discuss it.

It's quite important that anyone should know how to release,
as we plan to release every week an enhanced version.

2024-07-18 16:03:19 +02:00

2.0 KiB

Raw Blame History

Releasing new version

Whenever we are cooking a new release (e.g. 4.18.1) we should follow a standard procedure described below:

Create a new branch named: release/4.18.1.
Bump the release number in the appropriate file, i.e. for backend in the pyproject.toml and package.json for node-based projects (tips: find and replace all occurrences of the previous version number to ensure consistency across files).
Update the project's Changelog following the keepachangelog recommendations.

Update Docker image tag in Helm values files located at src/helm/env.d for both preprod and production environments:

image:
  repository: lasuite/meet-backend
  pullPolicy: Always
  tag: "v4.18.1" # Replace with the latest Docker image tag.

Commit your changes with a structured message:
- Add a title including the version of the release and respecting the above described format using the 🔖 release emoji.
- Paste in the body all changes from the changelog concerned by this release, removing only the Markdown tags and making sure that lines are shorter than 74 characters.
```
🔖(minor) bump release to 4.18.0

Added:

- Implement base CLI commands (list, extract, fetch & push) for supported backends
- Support for ElasticSearch database backend

Changed:

- Replace LDP storage backend by FS storage backend`
```
Open a pull request.
Wait for an approval from your peers.
Merge your pull request.
Checkout and pull changes from the main branch to ensure you have the latest updates.
Tag & push your commit: git tag v4.18.1 && git push origin --tags
Manually release your version on GitHub.
Ensure that the CI Docker job has successfully pushed the newly built Docker images to Docker Hub with the appropriate tags.
To deploy using ArgoCD, you need to update the production or pre-production tags. ArgoCD will automatically detect and deploy the new tag.

2.0 KiB Raw Blame History

Releasing new version

2.0 KiB

Raw Blame History