README.md 1.17 KB
Newer Older
Philip ABBET's avatar
Philip ABBET committed
1 2 3 4 5 6 7 8 9 10 11
# BEAT Python environment

This package contains docker instructions for building a container for the Python
backend of the BEAT platform.


## Usage

To test the creation of a container on your machine, run the following command:

```sh
12
$ docker build --rm=true -t docker.idiap.ch/beat/beat.env.python:1.0.0r3 .
Philip ABBET's avatar
Philip ABBET committed
13
```
14 15 16 17 18 19 20


## Integration with Gitlab CI

By default, nothing is done on the CI when commits are pushed to the Gitlab
repository.

21 22 23 24 25 26
To trigger the build of a docker image, push a tag of the form *vX.Y.ZrR*. This
will create an image with the name *docker.idiap.ch/beat/beat.env.python:X.Y.ZrR*.

In this versioning scheme, *X.Y.Z* represents the **version of the environment**
(ie. the same than the one returned by the *describe* script). *R* indicates the
revision of this environment.
27 28 29

To trigger the upload of the image to the *docker.idiap.ch* registry, you can push
a special tag (see below). Note that the commit you are tagging **must** also have
30
a *vX.Y.ZrR* tag, and that this build must have successfully passed.
31 32

The special tag must start with *push* (examples: *push*, *push_thisversion*).
33
This will upload the image with the name *docker.idiap.ch/beat/beat.env.python:X.Y.ZrR*