Skip to content

Commit cb8a7e2

Browse files
committed
Document the Docker tag policy and manual build requests
1 parent 9edf316 commit cb8a7e2

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,32 @@ For lists of builds see:
3737

3838
## Docker images
3939

40-
Docker images for Bob's Elixir and Erlang builds are built periodically. Bob checks for new Elixir and Erlang releases every 15 minutes and builds images for any new versions it discovers. The list of operating system distributions we base the images on can be found here: https://github.com/hexpm/bob/blob/main/lib/bob/job/docker_checker.ex#L5.
40+
Docker images for Bob's Elixir and Erlang builds are built periodically. Bob checks for new Elixir and Erlang releases every 15 minutes and builds images for any new versions it discovers. The list of operating system distributions we base the images on is defined by `builds/0` in https://github.com/hexpm/bob/blob/main/lib/bob/job/docker_checker.ex.
41+
42+
Bob automatically builds the latest patch release of every version family: the newest release per Erlang `major.minor` line (for example only `26.2.5.21` out of the `26.2.x` line) and the newest Elixir patch release per minor version, for every compatible OTP major. Older patch versions are not built automatically but can be requested manually, see below.
4143

4244
Tagged images are never changed, that means `hexpm/erlang@22.0-alpine-3.11.2` will always target the tag `OTP-22.0` and won't update when `OTP-22.0.1` is released.
4345

44-
Erlang builds are found at https://hub.docker.com/r/hexpm/erlang, they use the versioning scheme `${OTP_VER}-${OS_NAME}-${OS_VER}` for tags. Builds for all releases since OTP 17 are provided.
46+
Erlang builds are found at https://hub.docker.com/r/hexpm/erlang, they use the versioning scheme `${OTP_VER}-${OS_NAME}-${OS_VER}` for tags.
4547

46-
Elixir builds are found at https://hub.docker.com/r/hexpm/elixir, they use the versioning scheme `${ELIXIR_VER}-erlang-${OTP_VER}-${OS_NAME}-${OS_VER}`. Builds for all major releases since Elixir 1.0.0 are provided. Images are built for all pairs of compatible Elixir and OTP versions.
48+
Elixir builds are found at https://hub.docker.com/r/hexpm/elixir, they use the versioning scheme `${ELIXIR_VER}-erlang-${OTP_VER}-${OS_NAME}-${OS_VER}`.
4749

4850
Builds are provided for the following OS and architectures using the docker `OS/ARCH` scheme:
4951

5052
* `linux/amd64`
5153
* `linux/arm64/v8`
5254

55+
All provided images and tags can be searched at https://bob.hex.pm/docker.
56+
5357
### Examples of image names
5458

5559
* `hexpm/erlang:22.2.8-alpine-3.11.3`
5660
* `hexpm/erlang:22.2-ubuntu-bionic-20200219`
5761
* `hexpm/elixir:1.10.2-erlang-22.2.8-alpine-3.11.3`
5862
* `hexpm/elixir:1.10.0-erlang-22.2-ubuntu-bionic-20200219`
63+
64+
### Requesting builds
65+
66+
If you need a specific patch version that is not built automatically, request it at https://bob.hex.pm/request. Sign in with your hex.pm account, then pick the image kind (Erlang or Elixir), the OS and base image version, and the exact Erlang (and Elixir) version. The image is built for both architectures, including the multi-arch manifest; when an Elixir image needs an Erlang base image that does not exist yet, the base is built first and the Elixir image follows automatically.
67+
68+
Requested builds are limited to ten image builds per user per hour. Build progress can be followed on the jobs dashboard at https://bob.hex.pm.

0 commit comments

Comments
 (0)