Add docs for releases and docker hub images

go-graphite · May 14, 2020 · 63cf605 · 63cf605
1 parent 7d65cfa
commit 63cf605
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/DOCKER.md b/docs/DOCKER.md
@@ -0,0 +1,6 @@
+# Docker images and tags
+The images `innogames/graphite-ch-optimizer` are available on docker-hub with the following tags:
+
+- `${semantic_version}` (`docker/graphite-ch-optimizer/Dockerfile`) - these tags are automatically built from tags with tag regexp `v([.0-9]+)`
+- `latest` (`docker/graphite-ch-optimizer/Dockerfile`) - is built automatically from the latest `master` commit
+- `builder` (`docker/builder/Dockerfile`) - is built automatically from the latest `master` commit
diff --git a/docs/RELEASE.md b/docs/RELEASE.md
@@ -0,0 +1,6 @@
+# CREATE NEW RELEASE
+When the code is ready to new release, create it with the tag `v${major_version}.${minor_version}.${patch_version}`.  
+We have a [workflow](../.github/workflows/upload-assets.yml), which will upload created DEB and RPM packages together with hash sums as the release assets.
+
+## Use Jenkins to upload packages to deb-drop repository
+When the release is ready and assets are uploaded, launch the multibranch pipeline job configured against [Jenkinsfile](../Jenkinsfile) with desired version. It will download the package, compare hashsums and upload it to the repository.