You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/releasing-workflow-instructions.md
+35-35Lines changed: 35 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,46 +4,46 @@ The process of creating staging/release/hotfix versions of code from [Master](ht
4
4
5
5
## Description
6
6
7
-
Each commit on the master branch triggers a CI workflow that builds the simcore platform docker images.
8
-
These docker images are then stored on [dockerhub](https://hub.docker.com/repositories/itisfoundation) registry in the itisfoundation repository.
9
-
Each docker image are named following this pattern:
7
+
Each commit on the *master* branch triggers a CI workflow that builds the simcore platform docker images.
8
+
These docker images are then stored on [dockerhub](https://hub.docker.com/repositories/itisfoundation) registry in the itisfoundation [repository](https://hub.docker.com/repositories/itisfoundation).
9
+
Each docker image are named with the following pattern:
- GIT_SHA is the git SHA corresponding to the code used for building
16
+
-``CINAME`` the name of the CI
17
+
-``BUILD_DATE`` is the build date
18
+
-``BUILD_TIME`` is the build time
19
+
-``GIT_SHA is`` the git SHA corresponding to the code used for building
20
20
21
21
### Example
22
22
23
-
The ``webserver`` service in master branch with commit ``752ef...`` will be built by ``github`` actions CI on ``2020/08/31`` at ``12:36`` and therefore the image is named as:
23
+
The ``webserver`` service in *master* branch with commit ``752ef...`` will be built by *github actions* CI on ``2020/08/31`` at ``12:36`` and therefore the image is named as:
A staging version of simcore is like a pre-released version, that is marked as such on the master branch by leveraging Githubpre-release tagging mechanism. The CI is triggered and will pull the marked docker images (by using the given git SHA or latest master build), and tag them as staging images.
31
-
Each docker image are renamed as:
30
+
A staging version of simcore is a *pre-released* version that is marked as such on the *master* branch by leveraging *Github*pre-release tagging mechanism. The CI is triggered and will pull the marked docker images (by using the given git SHA or latest *master* build), and tag them as staging images.
- BUILD_NAMEVERSION is a one word name and a number (e.g. DaJia0, Dajia1, ...)
40
-
- BUILD_DATE is the build date
41
-
- BUILD_TIME is the build time
42
-
- GIT_SHA is the git SHA corresponding to the code used for building
38
+
-``CINAME`` the name of the CI
39
+
-``BUILD_NAMEVERSION`` is a one word name and a number (e.g. DaJia0, Dajia1, ...)
40
+
-``BUILD_DATE`` is the build date
41
+
-``BUILD_TIME`` is the build time
42
+
-``GIT_SHA`` is the git SHA corresponding to the code used for building
43
43
44
44
### Staging example
45
45
46
-
Just before the review of the ``DAJIA`` sprint we release a staging version ``v1.0.0``, the commit ``752ef...`` from above is tagged as stage and the ``github`` actions CI on ``2020/09/01`` at ``17:30``.
46
+
Just before the review of the ``DAJIA`` sprint we release a staging version ``v1.0.0``, the commit ``752ef...`` from above is tagged as stage and the *Github actions* CI on ``2020/09/01`` at ``17:30``.
make release-staging name=SPRINTNAME version=VERSION (git_sha=OPTIONAL)
64
64
```
65
-
66
65
2. Adjust the list of changes if needed
67
66
3. Press the **Publish release** button
68
67
4. The CI will be automatically triggered and will deploy the staging release
69
68
69
+
70
70
## Release process
71
71
72
-
A released version of simcore, that is marked as such on the master branch by leveraging Github release tagging mechanism. The CI is triggered and will pull the marked staging docker images (by using the given git SHA or the latest staging images), and tag them as release images.
72
+
A released version of simcore, that is marked as such on the *master* branch by leveraging *Github* release tagging mechanism. The CI is triggered and will pull the marked staging docker images (by using the given git SHA or the latest staging images), and tag them as release images.
73
73
**NOTE:** A release version is ALWAYS preceded by a staging version. The CI will fail if it does not find the corresponding staging version.
74
74
Each docker build marked as released are tagged as:
@@ -109,10 +109,10 @@ The team decides to release to production the lastest staging version of ``DAJIA
109
109
110
110
A hotfix is **ALWAYS made from an already released version**. A branch is created from the tagged release version (must be named hotfix_v*) and the fix is implemented there following usual best practices. On each commit in that branch the CI is triggered and will generate the following images in Dockerhub:
Once ready, the release-hotfix process starts by leveraging Github release mechanism. The CI will trigger again and pull the docker images (based on git SHA or latest hotfix image) and push a new release version.
115
+
Once ready, the release-hotfix process starts by leveraging *Github* release mechanism. The CI will trigger again and pull the docker images (based on git SHA or latest hotfix image) and push a new release version.
116
116
117
117
Each docker build marked as released are tagged as described in the Release process.
118
118
@@ -127,7 +127,7 @@ A bug was found in version 1.2.0 of the simcore stack. The team decides to fix i
0 commit comments