From 172612c340698c8f8bf0cf0c228f975c83421186 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thibaut=20Barr=C3=A8re?= Date: Thu, 13 Jan 2022 15:32:28 +0100 Subject: [PATCH 1/2] Improve documentation --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index fb8fa8d..56dcfdc 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,16 @@ This repository contains a Docker setup to consolidate various converters and va This is an internal build, but we are still publishing it as open-source in case it helps other (without support at this point). +### Release process + +To create a new release as a Docker image, just create a GitHub release: it is important that you create a tag named `v1.0.x` or similar, and that the release has the same name + changelog. + +On release creation (see https://github.com/etalab/transport-tools/blob/master/.github/workflows/docker.yml), a build will start, and should normally result into the publication of a GitHub-hosted Docker image named just like the release. + +One major caveat: the workflow must exist at the moment the tag is created (https://github.community/t/workflow-set-for-on-release-not-triggering-not-showing-up/16286/7): + +> The trigger only executes when a release is created using a tag that contains the workflow. + ### Use from Docker container registry * Install [Docker Desktop](https://www.docker.com/products/docker-desktop) From c6a158f236780305cbe9d361de1651dfd40d681b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thibaut=20Barr=C3=A8re?= Date: Thu, 13 Jan 2022 15:37:05 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 56dcfdc..3e0c13e 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ To create a new release as a Docker image, just create a GitHub release: it is i On release creation (see https://github.com/etalab/transport-tools/blob/master/.github/workflows/docker.yml), a build will start, and should normally result into the publication of a GitHub-hosted Docker image named just like the release. +You can find the release here: https://github.com/etalab/transport-tools/pkgs/container/transport-tools + One major caveat: the workflow must exist at the moment the tag is created (https://github.community/t/workflow-set-for-on-release-not-triggering-not-showing-up/16286/7): > The trigger only executes when a release is created using a tag that contains the workflow.