Skip to content

Commit 5046e86

Browse files
ghubertpalojpraynaud
authored andcommitted
add a schematic
1 parent ea7173e commit 5046e86

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed
168 KB
Loading

docs/adr/003-release.md renamed to docs/adr/003-release/index.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
slug: 3
33
title: |
44
3. Release process and versioning
5-
authors: [Jean-Philippe Raynaud, Denis Jouenne, Grégoire Hubert]
5+
authors:
6+
- name: Mithril Team
67
tags: [Draft]
78
---
89

@@ -37,7 +38,7 @@ There are 3 versioned layers in the Mithril stack:
3738

3839
* HTTP API protocol to ensure compatibility in the communication between nodes (use Semver)
3940
* Crate version: each node & library has its own version (use Semver) the commit digest is automatically added to the version by the CI pipeline.
40-
* Release Version: the distribution version (use version scheme YYWW.patch|YYWW.patch-name). The VERSION file is computed by the pipeline from the tag release.
41+
* Release Version: the distribution version (use version scheme **YYWW.patch** | **YYWW.patch-name**). The VERSION file is computed by the pipeline from the tag release.
4142

4243
The documentation is tied to a Release Version.
4344

@@ -48,11 +49,15 @@ Starting just after a new release has been made:
4849
1. Develop on a dedicated development branch
4950
1. When merging PR on main: update the `Cargo.toml` files with version of the updated nodes
5051
1. Once merged, the CI creates an `unstable` tag & release which is deployed on testing environment
51-
1. Push a tag using the distribution version format on this commit with a `-pre_release` suffix.
52+
1. Push a tag using the distribution version format on this commit with a `-prerelease` suffix.
5253
1. The CI gets the built artifacts associated with this commit and generates a named pre-release which is deployed on `pre-release` for testing.
53-
1. Push a tag using the distribution version format on this commit without the `-pre_release` suffix.
54+
1. Push a tag using the distribution version format on this commit without the `-prerelease` suffix.
5455
1. The CI gets the built artifacts associated with this commit and generates a named release which is deployed on `pre-release` for testing.
5556
1. In the release GitHub interface, edit the newly generated release, uncheck the `This is a pre-release` tick box.
5657
1. The CI gets the built artifacts associated with this commit and generates a named release which is deployed on `release`.
57-
1. Update the documentation website from future to current.
58+
1. Create a commit:
59+
1. to promote the documentation website from future to current.
60+
1. to update the SQL schema with alterations from the previous release.
61+
62+
[![Release Process](./img/release_process.jpg)](./img/release_process.jpg)
5863

0 commit comments

Comments
 (0)