Skip to content

Commit 4aa3669

Browse files
committed
doc: explain new Docker images tagging scheme
1 parent 6532d71 commit 4aa3669

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,18 @@ Please note that the environment and scripts are validated on Ubuntu and macOS.
6464

6565
We also provide an experimental configuration to deploy Stellio in a k8s cluster (only tested in Minikube as of now). For more information, please look at [the README](kubernetes/README.md)
6666

67+
## Docker images tagging
68+
69+
Starting from version 2.0.0, a new scheme is used for tagging of Docker images:
70+
* Releases are tagged with the version number, e.g., `stellio/stellio-search-service:2.0.0`
71+
* `latest` tag is no longer used for releases as it can be dangerous (for instance, triggering an unwanted major
72+
upgrade)
73+
* Developement versions (automatically produced when a commit is pushed on the `develop` branch) are tagged with a
74+
tag containing the `-dev` suffix, e.g., `stellio/stellio-search-service:2.1.0-dev`
75+
* On each commit on the `develop` branch, an image with the `latest-dev` tag is produced, e.g., `stellio/stellio-search-service:latest-dev`
76+
77+
The version number is obtained during the build process by using the `version` information in the `build.gradle.kts` file.
78+
6779
## Development
6880

6981
### Developing on a service
@@ -186,4 +198,4 @@ It mainly makes use of the following libraries and frameworks (dependencies of d
186198
| WireMock | APL v2 |
187199
| Testcontainers | MIT |
188200

189-
© 2020 - 2022 EGM
201+
© 2020 - 2023 EGM

0 commit comments

Comments
 (0)