Skip to content

Commit 9bcc3cd

Browse files
author
SilviaAmAm
committed
📝 feat: Document release flow
1 parent 6a8e4b5 commit 9bcc3cd

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

docs/developers/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ This section is for developers working on the project.
99
setup-local-environment
1010
environment-variables
1111
health-checks
12+
release-flow

docs/developers/release-flow.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. _developers_release:
2+
3+
============
4+
Release flow
5+
============
6+
7+
#. Checkout a branch ``release/X.X.X`` (with the new version number)
8+
#. In the root folder, use ``bump-my-version show-bump`` to show the possibilities, for example:
9+
10+
.. code:: bash
11+
12+
bump-my-version show-bump
13+
14+
0.1.0 ── bump ─┬─ major ─ 1.0.0
15+
├─ minor ─ 0.2.0
16+
├─ patch ─ 0.1.1
17+
├─ pre_l ─ invalid: The part has already the maximum value among ['', 'alpha', 'beta', 'rc', 'final'] and cannot be bumped.
18+
╰─ pre_n ─ 0.1.0-final.1
19+
20+
#. Bump the version. For example ``bump-my-version bump major``.
21+
#. In the ``frontend/`` folder, run ``npm install`` to also update the ``package-lock.json`` file after the ``package.json`` has been bumped.
22+
#. In the ``backend/`` folder, run ``./bin/make_translations.sh`` and check if any translations need changing.
23+
#. In the ``backend/`` folder, run ``./bin/update_oas.sh`` to update the OAS.
24+
#. Update the ``CHANGELOG.md`` file.
25+
#. Commit the changes and push the branch.
26+
#. Once the branch is approved, merge it into main.
27+
#. Create a tag with ``git tag -a 1.0.0 -m ":bookmark: Release 1.0.0"``.
28+
#. Push the tag with ``git push origin 1.0.0``.
29+
#. Once the new image has been pushed to Dockerhub, celebrate! 🎉

0 commit comments

Comments
 (0)