cicirello / pyaction

A Docker container with Python, git, and the Github CLI

pyaction

Website for our GitHub Actions and tools for developing them: https://actions.cicirello.org/

Summary

Docker Hub
GitHub
Image Stats
Build Status
License
Support

This Docker image is designed to support implementing Github Actions with Python. As of version 4.0.0., it starts with the official python docker image as the base, which is a Debian OS. It specifically uses python:3-slim to keep the image size down for faster loading of Github Actions that use pyaction. On top of the base, we've installed curl, gpg, git, and the GitHub CLI. We added curl and gpg because they are needed to install the GitHub CLI, and they may come in handy anyway (especially curl) when implementing a GitHub Action.

Blog Post on DEV: pyaction: A Docker container with Python, git, and the GitHub CLI, posted on December 28, 2022. See a list of additional blog posts later in this README.

Multiplatform Image

Version 4.0.0 and Newer: pyaction supports the following platforms:

• linux/386
• linux/amd64
• linux/arm/v7
• linux/arm64

Version 3.14.0 and Earlier: earlier releases supported the above as well as the following:

• linux/arm/v6
• linux/ppc64le
• linux/s390x

Source Repository and Builds

The source repository is maintained on GitHub. The images are built on Github and pushed to Docker Hub, as well as the Github Container Registry using Github Actions.

Our daily automated CI/CD processes monitor for updates to the Python slim Docker image, the GitHub CLI, etc. Upon detecting such updates, we release an update of pyaction sometimes as early as same day, but possibly a few days later.

See CHANGELOG for details of versions of Python, GitHub CLI, git, etc included in each pyaction release.

Docker Tags and Versioning Scheme

We use Semantic Versioning for our tags. Semantic Versioning uses version numbers of the form: MAJOR.MINOR.PATCH, where differences in MAJOR correspond to incompatible changes, differences in MINOR correspond to introduction of backwards compatible new functionality, and PATCH corresponds to backwards compatible bug fixes.

Each image pushed to Docker Hub and the Github Container Registry is tagged as follows:

• The tag latest indicates, well, the latest image.
• Tags of the form MAJOR.MINOR.PATCH (e.g., 4.0.0).
• Tags of the form MAJOR.MINOR (e.g., 4.0).
• Tags of the form MAJOR (e.g., 4).

Installation and Usage

The pre-built image is hosted on both Docker Hub and the Github Container Registry. You can use it in the following ways.

Docker Pull Command

Pull the latest image from Docker Hub with the following (replace latest with a specific version number if you prefer):

docker pull cicirello/pyaction:latest

Pull from the Github Container Registry with:

docker pull ghcr.io/cicirello/pyaction:latest

Use as a base image in a Dockerfile

Use as a base image in a Dockerfile (replace latest with a specific version number if you prefer):

FROM cicirello/pyaction:latest

# The rest of your Dockerfile would go here.

Or you can use as a base image (via the Github Container Registry) with:

FROM ghcr.io/cicirello/pyaction:latest

# The rest of your Dockerfile would go here.

Blog Posts

Here are a few blog posts about the pyaction container listed in reverse chronological order:

• Celebrating over 2 million pulls of pyaction from the GitHub Container Registry, posted on September 2, 2023.
• pyaction: Over 1 million pulls from the GitHub Container Registry, posted on February 16, 2023.
• pyaction: A Docker container with Python, git, and the GitHub CLI, posted on December 28, 2022.

License

Source Code License

The source code, including the Dockerfile and anything else within the Github repository for pyaction, is licensed under the MIT License.

Image Licenses

As with all pre-built Docker images, the image itself (once built, or obtained from Docker Hub or the Github Container Registry) contains software that is covered by a variety of licenses. See the license information for the python docker image, the license for git, the GitHub CLI, and the license for Python.

If you build and distribute an image containing your software, using pyaction as the base image, it is your responsibility to follow the licenses of all of the software contained within the image.

pyaction's Issues

Automated Changelog update updates wrong section of Changelog

Describe the bug
Automated changelog update changes the prior version section's changed section rather than unreleased's changed section.

Build fails due to GitHub CLI's expired GPG key

Summary

Build failing due to GitHub CLI's expired GPG key. See cli/cli#6175

Update documentation for version 4.0.0.

Version 4.0.0 added the GitHub CLI, etc, and also changed the base image, and removed support for a few archs. The readme needs to be updated both here on GitHub as well as on Docker Hub.