ci: support for stable build

[jenhagg]

Purpose

Add version argument to docker build which allows reusing the dockerfile to produce both latest and stable images.

What the code is doing

The latest branch is unchanged, but now we could also pass stable as an input to the workflow, which will get passed as a build-arg to docker, causing it to install the package from PyPI instead. The default image in the compose file is changed to be stable, but a user can override this using the .dev.yml file.

Testing

Tested the bash script and stable build from the command line, and tested the workflow input functionality in my test-ci repo. Example:

cd build
docker build . -t client:stable --build-arg version=stable

Time estimate

5 min

[kasparm]

Maybe this is a detail but why is the default in the Dockerfile latest?

[jenhagg]

It's arbitrary, but nice to have a default so if we do a docker build with no --build-arg we still get something useful. Note, we also duplicate that default value in the workflow inputs, since the workflow-trigger action doesn't yet support that.

[kasparm]

Thanks! Looks good.

[BainanXia]

LGTM. Just to confirm my read, from now on, if we build an image, a build-arg being either stable or latest should be specified, right? There is no default behavior without specifying the parameter. But if we run docker compose, for docker-compose.dev.yml, it will do latest and for docker-compose.yml, it's stable.

[jenhagg]

Just to confirm my read, from now on, if we build an image, a build-arg being either stable or latest should be specified, right? There is no default behavior without specifying the parameter.

The version build arg is only required for stable since it's defaulted to latest in the Dockerfile. But it is correct to say that it must be one of those two values.

But if we run docker compose, for docker-compose.dev.yml, it will do latest and for docker-compose.yml, it's stable.

Kind of, but just to clarify, pretty much all you can do with docker-compose.dev.yml on its own is the latest build. E.g. you can run docker-compose -f docker-compose.dev.yml build and that will work fine. But something like docker-compose -f docker-compose.dev.yml up won't really work as expected unless the base docker-compose.yml file is also included, as in this section of the readme. To be honest if I want to use latest, I would probably just build it and edit docker-compose.yml to use that instead, but the .dev.yml file provides a way to do that without changing anything.