cimg/deploy pulls statistics

<div align="center"> <p> <img alt="CircleCI Logo" src="https://raw.github.com/CircleCI-Public/cimg-deploy/main/img/circle-circleci.svg?sanitize=true" width="75" /> <img alt="Docker Logo" src="https://raw.github.com/CircleCI-Public/cimg-deploy/main/img/circle-docker.svg?sanitize=true" width="75" /> </p> <h1>CircleCI Convenience Images => Deploy</h1> <h3>A Continuous Delivery & Deployment focused Docker image built to run on CircleCI</h3> </div>

cimg/deploy is a Docker image created by CircleCI with continuous delivery and deployment pipelines in mind. Each tag is a date-based snapshot of many deployment related tools such as kubectl, terraform, and much more. If you find this image useful but also want the AWS CLI, please check out cimg/aws. GCP and Azure images are coming soon.

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:

jobs:
  build:
    docker:
      - image: cimg/deploy:2022.06.1
    steps:
      - checkout
      - run: echo "Do things"

In the above example, the CircleCI Deploy Docker image is used for the primary container. More specifically, the tag 2022.06.1 is used meaning this is the 1st April 2022 snapshot. You can now use all of the tools pre-installed in this image in this job.

How This Image Works

This image is published on a monthly basis. Each month, we'll update the main tools to newer versions as they are available.

Variants

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

Node.js

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

jobs:
  build:
    docker:
      - image: cimg/deploy:2022.06.1-node
    steps:
      - checkout
      - run: node --version

Tagging Scheme

This image has the following tagging scheme:

cimg/deploy:YYYY.MM.I[-variant]

The tag will be YYYY.MM.I where YYYY is the 4 digit year, MM is the 2 digit month, and I is the nth release of that month. The last piece there typically will only change when we need to patch an image for that month.

[-variant] - Variant tags, if available, can optionally be used. For example the Node.js variant is available, it can be used like this: cimg/deploy:2022.06.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 (v20.10+)

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 --init 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-deploy.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-deploy.git

Generating Dockerfiles

Dockerfiles can be generated by using the gen-dockerfiles.sh script. For example, you would run the following from the root of the repo:

./shared/gen-dockerfiles.sh 2022.06.1

The generated Dockerfile will be located at ./2022.06/Dockefile. To build this image locally and try it out, you can run the following:

cd 2022.06
docker build -t test/deploy:2022.06.1 .
docker run -it test/deploy:2022.06.1 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.

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 date April 1991, you would run the following from the repo root:

./shared/release.sh 1991.04.2

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:…