Skip to content

Latest commit

 

History

History
270 lines (191 loc) · 10.9 KB

README.md

File metadata and controls

270 lines (191 loc) · 10.9 KB
Raw

CircleCI Logo Docker Logo Elixir Logo

CircleCI Convenience Images => Elixir

A Continous Integration focused Elixir Docker image built to run on CircleCI

CircleCI Build Status Software License Docker Pulls CircleCI Community Repository

This image is designed to supercede the legacy CircleCI Elixir image, circleci/elixir.

cimg/elixir is a Docker image created by CircleCI with continuous integration builds in mind. Each tag contains a complete Elixir installation for use with mix and hex.

Support Policy

The CircleCI Docker Convenience Image support policy can be found on the CircleCI docs site. This policy outlines the release, update, and deprecation policy for CircleCI Docker Convenience Images.

Table of Contents

Getting Started

This image can be used with the CircleCI docker executor. For example:

jobs:
  build:
    docker:
      - image: cimg/elixir:1.9
    steps:
      - checkout
      - run: mix --version
      - run: mix deps.get
      - run: mix test

In the above example, the CircleCI Elixir Docker image is used as the primary container. More specifically, the tag 1.9 is used meaning the version of elixir will be v1.9. You can now use mix within the steps for this job.

How This Image Works

This image contains both Elixir as well as a supported version of Erlang.

Parent Tags and Parent Slugs

Parent Tags introduce the ability to choose a specific version to include in the tag. In conjunction with the Parent Slug, Elixir now supports choosing which Erlang version to use and looks like: parentSlug-parentTag, which would translate to erlang-22.3

Variants

Variant images typically contain the same base software, but with a few additional modifications.

Node.js

The Node.js variant is the same Elixir image but with Node.js also installed. The Node.js variant can be used by appending -node to the end of an existing cimg/elixir tag.

jobs:
  build:
    docker:
      - image: cimg/elixir:1.11-node
    steps:
      - checkout
      - run: mix --version
      - run: node --version

Browsers

The browsers variant is the same Elixir image but with Node.js, Selenium, and browser dependencies pre-installed via apt. The browsers variant can be used by appending -browsers to the end of an existing cimg/elixir tag. The browsers variant is designed to work in conjunction with the CircleCI Browser Tools orb. You can use the orb to install a version of Google Chrome and/or Firefox into your build. The image contains all of the supporting tools needed to use both the browser and its driver.

orbs:
  browser-tools: circleci/browser-tools@1.1
jobs:
  build:
    docker:
      - image: cimg/elixir:1.11-browsers
    steps:
      - browser-tools/install-browser-tools
      - checkout
      - run: |
          mix --version
          node --version
          java --version
          google-chrome --version

Tagging Scheme

This image has the following tagging scheme:

cimg/elixir:<elixir-version>[-erlang-version][-variant]

<elixir-version> - The version of Elixir to use. This can be a full SemVer point release (such as 1.10.2) or just the minor release (such as 1.10). If you use the minor release tag, it will automatically point to future patch updates as they are released by the Elixir project. For example, the tag 1.10 points to elixir 1.10.2 now, but when the next release comes out, it will point to 1.10.3.

<erlang-version> - This specifies the erlang version to use in accordance with the compatibility chart. Note: the default image tag: cimg/elixir:<elixir-version>[-variant] will utilize the latest version e.g 24.3

[-variant] - Variant tags, if available, can optionally be used. For example, the Node.js variant can be used like this: cimg/elixir:1.10.1-node.

Development

Images can be built and run locally with this repository. This has the following requirements:

  • local machine of Linux (Ubuntu tested) or macOS
  • modern version of Bash (v4+)
  • modern version of Docker Engine (v19.03+)

Cloning For Community Users (no write access to this repository)

Fork this repository on GitHub. When you get your clone URL, you'll want to add --recurse-submodules to the clone command in order to populate the Git submodule contained in this repo. It would look something like this:

git clone --recurse-submodules <my-clone-url>

If you missed this step and already cloned, you can just run git submodule update --recursive to populate the submodule. Then you can optionally add this repo as an upstream to your own:

git remote add upstream https://github.com/CircleCI-Public/cimg-elixir.git

Cloning For Maintainers ( you have write access to this repository)

Clone the project with the following command so that you populate the submodule:

git clone --recurse-submodules git@github.com:CircleCI-Public/cimg-elixir.git

Generating Dockerfiles

Dockerfiles can be generated for a specific elixir version using the gen-dockerfiles.sh script. For example, to generate the Dockerfile for elixir v1.10.2, you would run the following from the root of the repo:

./shared/gen-dockerfiles.sh 1.10.2

The generated Dockerfile will be located at ./1.10/<parent-tag>/Dockefile in addition to their corresponding variants located at ./1.10/<parent-tag>/<variant>/Dockefile

To build this image locally and try it out, you can run the following (assuming a 23.3 erlang version):

cd 1.10
docker build -t test/elixir:1.10.2-erlang-23.3 .
docker run -it test/elixir:1.10.2-erlang-23.3 bash

If using the default version (latest), you could run either of the following:

docker build -t test/elixir:1.10.2 .
docker run -it test/elixir:1.10.2 bash

docker build -t test/elixir:1.10.2-erlang-24.3 .
docker run -it test/elixir:1.10.2-erlang-24.3 bash

Building the Dockerfiles

To build the Docker images locally as this repository does, you'll want to run the build-images.sh script:

./build-images.sh

This would need to be run after generating the Dockerfiles first. When releasing proper images for CircleCI, this script is run from a CircleCI pipeline and not locally.

Submitting a Pull Request

Ensure all the changes to the versioned Dockerfiles and the build-images.sh have been reverted, leaving only the Dockerfile.template as the modified file. These will have been modified while testing with the sections above. The specific versions will be included when the images are released.

Publishing Official Images (for Maintainers only)

The individual scripts (above) can be used to create the correct files for an image, and then added to a new git branch, committed, etc. A release script is included to make this process easier. To make a proper release for this image, let's use the fake elixir version of v99.9.9, you would run the following from the repo root:

./shared/release.sh 99.9.9

This will automatically create a new Git branch, generate the Dockerfile(s), stage the changes, commit them, and push them to GitHub. The commit message will end with the string [release]. This string is used by CircleCI to know when to push images to Docker Hub. All that would need to be done after that is:

  • wait for build to pass on CircleCI
  • review the PR
  • merge the PR

The master branch build will then publish a release.

Incorporating Changes

How changes are incorporated into this image depends on where they come from.

build scripts - Changes within the ./shared submodule happen in its own repository. For those changes to affect this image, the submodule needs to be updated. Typically like this:

cd shared
git pull
cd ..
git add shared
git commit -m "Updating submodule for foo."

parent image - By design, when changes happen to a parent image, they don't appear in existing elixir images. This is to aid in "determinism" and prevent breaking customer builds. New elixir images will automatically pick up the changes.

If you really want to publish changes from a parent image into the elixir image, you have to build a specific image version as if it was a new image. This will create a new Dockerfile and once published, a new image.

elixir specific changes - Editing the Dockerfile.template file in this repo is how to modify the elixir image specifically. Don't forget that to see any of these changes locally, the gen-dockerfiles.sh script will need to be run again (see above).

Contributing

We encourage issues and pull requests against this repository.

Please check out our contributing guide which outlines best practices for contributions and what you can expect from the images team at CircleCI.

Additional Resources

CircleCI Docs - The official CircleCI Documentation website. CircleCI Configuration Reference - From CircleCI Docs, the configuration reference page is one of the most useful pages we have. It will list all of the keys and values supported in .circleci/config.yml. Docker Docs - For simple projects this won't be needed but if you want to dive deeper into learning Docker, this is a great resource.

License

This repository is licensed under the MIT license. The license can be found here.