Skip to content

Commit

Permalink
πŸ“(release) document releasing new version
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
lebaudantoine committed Jul 17, 2024
1 parent 6e20d53 commit 342a737
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Releasing new version

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

1. Create a new branch named: `release/4.18.1`.
2. 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).
3. Update the project's `Changelog` following the [keepachangelog](https://keepachangelog.com/en/0.3.0/) recommendations.
4. Update Docker image tag in Helm values files located at `src/helm/env.d` for both `preprod` and `production` environments:
```yaml
image:
repository: lasuite/meet-backend
pullPolicy: Always
tag: "v4.18.1" # Replace with the latest Docker image tag.
```
5. 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`
```
6. Open a pull request.
7. Wait for an approval from your peers.
8. Merge your pull request.
9. Checkout and pull changes from the `main` branch to ensure you have the latest updates.
10. Manually release your version on GitHub.
11. Ensure that the CI Docker job has successfully pushed the newly built Docker images to Docker Hub with the appropriate tags.
12. Tag & push your commit for deployment. For example for production: `git tag production && git push origin --tags`

0 comments on commit 342a737

Please sign in to comment.