Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cicirello/pyaction
A Docker container with Python, git, and the Github CLI
https://github.com/cicirello/pyaction
curl docker docker-image gh git github-actions github-api github-cli gpg linux python
Last synced: 3 months ago
JSON representation
A Docker container with Python, git, and the Github CLI
- Host: GitHub
- URL: https://github.com/cicirello/pyaction
- Owner: cicirello
- License: mit
- Created: 2020-09-13T17:46:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T11:15:23.000Z (4 months ago)
- Last Synced: 2024-10-19T15:05:08.984Z (4 months ago)
- Topics: curl, docker, docker-image, gh, git, github-actions, github-api, github-cli, gpg, linux, python
- Language: Python
- Homepage: https://actions.cicirello.org/pyaction/
- Size: 311 KB
- Stars: 33
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pyaction
[](#pyaction)
Website for our GitHub Actions and tools for developing them: https://actions.cicirello.org/
## Summary
| __Docker Hub__ | [](https://hub.docker.com/r/cicirello/pyaction) [](https://hub.docker.com/r/cicirello/pyaction) |
| :--- | :--- |
| __GitHub__ | [](https://github.com/cicirello/pyaction/releases) |
| __Image Stats__ | [](https://hub.docker.com/r/cicirello/pyaction) |
| __Build Status__ | [](https://github.com/cicirello/pyaction/actions/workflows/docker-image.yml) |
| __License__ | [](LICENSE) |
| __Support__ | [](https://github.com/sponsors/cicirello) [](https://liberapay.com/cicirello) [](https://ko-fi.com/cicirello) |
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](https://hub.docker.com/_/python) 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](https://curl.se/),
[gpg](https://gnupg.org/), [git](https://git-scm.com/), and the
[GitHub CLI](https://cli.github.com/). 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](https://dev.to/cicirello/pyaction-a-docker-container-with-python-git-and-the-github-cli-930), posted on December 28, 2022. See a [list of additional blog posts](#blog-posts) later in this README.
## Multiplatform Image
__Version 4.0.0 and Newer__: pyaction supports the following
platforms:
* linux/386
* linux/amd64
* linux/arm64
* linux/arm/v7
* linux/arm/v6
__Version 3.14.0 and Earlier__: earlier releases supported the
above as well as the following:
* linux/ppc64le
* linux/s390x
## Source Repository and Builds
The [source repository](https://github.com/cicirello/pyaction) is
maintained on GitHub. The images are built on Github and pushed
to [Docker Hub](https://hub.docker.com/r/cicirello/pyaction), as
well as the
[Github Container Registry](https://github.com/cicirello?ecosystem=container&tab=packages)
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](https://github.com/cicirello/pyaction/blob/master/CHANGELOG.md) for details of
versions of Python, GitHub CLI, git, etc included in each pyaction release.
## Docker Tags and Versioning Scheme
We use [Semantic Versioning](https://semver.org/) for our tags.
[Semantic Versioning](https://semver.org/) 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):
```Shell
docker pull cicirello/pyaction:latest
```
Pull from the Github Container Registry with:
```Shell
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):
```Dockerfile
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:
```Dockerfile
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](https://dev.to/cicirello/celebrating-over-2-million-pulls-of-pyaction-from-the-github-container-registry-20hb), posted on September 2, 2023.
* [pyaction: Over 1 million pulls from the GitHub Container Registry](https://dev.to/cicirello/pyaction-over-1-million-pulls-from-the-github-container-registry-29ag), posted on February 16, 2023.
* [pyaction: A Docker container with Python, git, and the GitHub CLI](https://dev.to/cicirello/pyaction-a-docker-container-with-python-git-and-the-github-cli-930), posted on December 28, 2022.
## License
### Source Code License
The source code, including the Dockerfile and anything
else within the [Github repository for pyaction](https://github.com/cicirello/pyaction),
is licensed under the
[MIT License](https://github.com/cicirello/pyaction/blob/master/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](https://hub.docker.com/_/python),
the [license for git](https://git-scm.com/),
the [GitHub CLI](https://github.com/cli/cli/blob/trunk/LICENSE),
and the [license for Python](https://docs.python.org/3/license.html).
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.