cimg/clojure pulls statistics

CircleCI Convenience Images => Clojure

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

This image is designed to supercede the original CircleCI Clojure image, circleci/clojure.

cimg/clojure is a Docker image created by CircleCI with continuous integration builds in mind. Each tag contains a Clojure version, a JVM, and any binaries and tools that are required for builds to complete successfully in a CircleCI environment.

Table of Contents

• Getting Started • How This Image Works • Development • Contributing • Additional Resources • License

Getting Started

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

In the above example, the CircleCI Clojure Docker image is used for the primary container. More specifically, the tag 1.10.3 is used meaning the version of Clojure will be Clojure v1.10.3. You can now use Clojure within the steps for this job.

How This Image Works

This image contains the Clojure programming language as installed via clj as well as Leiningen. These Clojure images contain OpenJDK v17 though alternates with support for OpenJDK v8 (and possibly) more are in the works..

Babashka is pre-installed. Please note that Babashka has frequent releases while CircleCI only releases Clojure images as the upstream project makes a release. There will be times were the pre-installed version of Babashka is older than you might want.

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, Clojure now supports choosing which OpenJDK version to use and looks like: parentSlug-parentTag, which would translate to openjdk-8.0

Variants

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

Node.js

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

Browsers

The browsers variant is the same Clojure image but with Node.js, Selenium, and browser dependencies pre-installed via apt. The browsers variant can be used by appending -browser to the end of an existing cimg/clojure 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.

Tagging Scheme

This image has the following tagging scheme:

• The version of Clojure to use. This can be a full SemVer point release (such as 1.10.1) 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 Clojure Team. For example, the tag 1.10 points to Clojure v1.10.1 now, but when the next release comes out, it will point to Clojure v1.10.2.

• This specifies the openjdk version to use. Note: the default image tag: cimg/clojure:[-variant] will utilize the latest version e.g 17.0

[-variant] - Variant tags, if available, can optionally be used. Once the Node.js variant is available, it could be used like this: cimg/clojure:1.10-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:

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:

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

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

Generating Dockerfiles

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

This is the Clojure version 1.10.3 followed by a version parameter, which is the Clojure number together with the build number, 1.10.3.1058. You can get the current build number from the [Linux Install Instructions][linux-version] for Clojure. It's the last part of the version in the example on that page.

The generated Dockerfile will be located at ./1.10//Dockefile in addition to their corresponding variants located at ./1.10///Dockefile

To build this image locally and try it out, you can run the following (assuming openjdk 8.0):

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

Building the Dockerfiles

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

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.

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, lets's use the fake Clojure version of Clojure v9.9.9, you would run the following from the repo root:

Here the fake Clojure version 9.9.9 is used followed by a version parameter, which is the fake Clojure number together with the fake build number, 9.9.9.1234. You can get the current build number from the [Linux Install Instructions][linux-version] for Clojure. It's the last part of the version in the example on that page.…