Skip to content

Commit

Permalink
Explication du processus de construction de release (#12)
Browse files Browse the repository at this point in the history
* Improve documentation

* Update README.md
  • Loading branch information
thbar authored Jan 13, 2022
1 parent cde8479 commit 370d98c
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ 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.

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.
### Use from Docker container registry

* Install [Docker Desktop](https://www.docker.com/products/docker-desktop)
Expand Down

0 comments on commit 370d98c

Please sign in to comment.