https://github.com/openzim/docker-publish-action
Docker Publish Action for OpenZIM projects
https://github.com/openzim/docker-publish-action
docker dockerhub ghcr github-actions
Last synced: 5 months ago
JSON representation
Docker Publish Action for OpenZIM projects
- Host: GitHub
- URL: https://github.com/openzim/docker-publish-action
- Owner: openzim
- Created: 2020-12-21T09:15:00.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-20T15:39:36.000Z (over 2 years ago)
- Last Synced: 2025-04-26T15:04:30.540Z (6 months ago)
- Topics: docker, dockerhub, ghcr, github-actions
- Language: Python
- Homepage: https://hub.docker.com/u/openzim
- Size: 32.2 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# docker-publish-action
[](https://github.com/openzim/docker-publish-action/releases/latest)
[](https://github.com/marketplace/actions/openzim-docker-publish-action)
[](https://github.com/openzim/docker-publish-action/actions?workflow=CI)
A Github Action to automatically build and publish Openzim's images to **Both Docker Hub and Github Container Regisry**.
## Requirements
On ghcr.io, as for Docker Hub, first part of image name is the *user* owning the image. The user or organization must have enabled *Improved container support* first. Users do that in Settings > Feature preview and Organizations in Settings > Packages.
⚠️ this action is tailored for Openzim's workflow only. Use at your own risk.
## Usage
### Minimal
```yaml
jobs:
build-and-push:
name: Deploy Docker Image
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: Build and push
uses: openzim/docker-publish-action@v9
with:
image-name: openzim/zimit
GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }}
GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }}
on-master: latest
```
### Complete
```yaml
name: Docker
on:
push:
branches:
- master
tags:
- v*
workflow_dispatch:
inputs:
version:
description: Specific version to build
required: false
default: ''
jobs:
build-and-push:
name: Deploy Docker Image
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: Build and push
uses: openzim/docker-publish-action@v9
with:
image-name: openzim/zimit
registries: |
docker.io
ghcr.io
credentials: |
DOCKERIO_USERNAME=${{ secrets.DOCKERHUB_USERNAME }}
DOCKERIO_TOKEN=${{ secrets.DOCKERHUB_PASSWORD }}
GHCRIO_USERNAME=${{ secrets.GOOGLE_USERNAME }}
GHCRIO_TOKEN=${{ secrets.GOOGLE_TOKEN }}
context: sub-folder
on-master: dev
tag-pattern: /^v*([0-9.]+)$/
latest-on-tag: true
restrict-to: openzim/zimit
build-args:
VERSION={tag}
manual-tag: ${{ github.event.inputs.version }}
webhook: https://api.sloppy.io/v1/apps/my-project/services/my-project/apps/my-app/deploy?user=${{ secrets.SLOPPY_USERNAME }}&auth=${{ secrets.SLOPPY_WEBHOOK_TOKEN }}
```
**Note**: th top-part `on` is just a filter on running that workflow. You can omit it but it's safer to not run it on refs that you know won't trigger anything. See [documentation](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on).
| Input | Usage |
| :--- | :--- |
| `image-name`\* | **Name of your image on the registry** (without the version part).
Ex.: `openzim/zimit` would refer to [this image](https://hub.docker.com/r/openzim/zimit).
The same name is pushed to **all registries**. |
| `registries` | **List of registries to push images to** (domain name only).
Ex.: `docker.io` for Docker Hub, `ghcr.io`, `gcr.io`, etc.
Defaults to `ghcr.io`. |
| `credentials`\* | **List of credentials for all registries**
Use the `REGISTRY_USERNAME=xxx` and `REGISTRY_TOKEN=xxx` formats to specify.
`REGISTRY` refers to the uppercase registry domain name without `.`.
Ex: `GHCRIO_USERNAME=xxx` for `ghcr.io`.
_Notes_: Github token is a [PAT](https://github.com/settings/tokens) with `repo, workflow, write:packages` permissions.
Docker hub token is account password.|
| `context` | **Path in the repository to use as build context**
Relative to repository root. Ex: `dnscache` or `workers/slave`.
Defaults to `.`. |
| `dockerfile` | **Path to the Dockerfile recipe, relative to context**
Use `../` syntax if dockerfile is outside context.
Defaults to `Dockerfile`. |
| `build-args` | **Arguments for `docker build --build-arg`**
Special value `{tag}` will be replaced with the tag to set.
Use the `name=value` format and separate each by a space or new line.|
| `platforms` | **List of platforms to build-for**.
Ex.: `linux/armv/v7 linux/amd64`.
Defaults to `linux/amd64`. |
| `on-master` | **Tag to apply for every commit on default branch**.
Omit it if you don't want to push an image for non-tagged commits.
Only applies to commits on your default branch (`master` or `main`) |
| `tag-pattern` | **Regular expression to match tags with**.
Only git tags matching this regexp will trigger a build+push to the corresponding docker tag.
If not specifying a group, whole git tag is used as is on docker. |
| `latest-on-tag` | **Whether to push to docker tag `:latest` on every matched tag** (see `tag-pattern`)
Also applies to `manual-tag`.
Value must be `true` or `false`. Defaults to `false`. |
| `manual-tag` | **Manual tag override**
Replaces `on-master` and `tag-pattern` if not empty.
Also triggers `:latest` if `latest-on-tag` is `true`. |
| `restrict-to` | **Don't push if action is run for a different repository**
Specify as `{owner}/{repository}`. |
| `webhook` | **URL to POST to after image is pushed**
Will receive a JSON POST request somewhat similar to Docker Hub webhook payload. |
| `repo_description` | **Text to set as repository description on docker.io's Hub (truncated to chars)**
If pushing to docker.io, will set this string as *repository description* on the Hub. Special value `auto` uses Github repository's description. |
| `repo_overview` | **Text (markdown) to set as repository overview on docker.io's Hub (truncated to 25KB)**
If pushing to docker.io, will set this string as *repository overview* on the Hub. If starting with **`file:`**, will use the content of referenced file instead. Relative to `context`. Example: `file:../welcome.md`. Special value **`auto`** will look for a `README[.md|rst]` file in context (and parents). |
⚠️ After your initial run creating your image, you need to manually **make it public** via Github's UI (see packages) if you intend to pull images without authenticating.