mirror of
https://github.com/docker/metadata-action.git
synced 2024-11-08 13:15:40 +01:00
198 lines
8.2 KiB
Markdown
198 lines
8.2 KiB
Markdown
[](https://github.com/crazy-max/ghaction-docker-meta/releases/latest)
|
|
[](https://github.com/marketplace/actions/docker-meta)
|
|
[](https://github.com/crazy-max/ghaction-docker-meta/actions?workflow=test)
|
|
[](https://codecov.io/gh/crazy-max/ghaction-docker-meta)
|
|
[](https://github.com/sponsors/crazy-max)
|
|
[](https://www.paypal.me/crazyws)
|
|
|
|
## About
|
|
|
|
GitHub Action to extract metadata (tags, labels) for Docker. This action is particularly useful if used with
|
|
[Docker Build Push](https://github.com/docker/build-push-action) action.
|
|
|
|
If you are interested, [check out](https://git.io/Je09Y) my other :octocat: GitHub Actions!
|
|
|
|
|
|
|
|
___
|
|
|
|
* [Features](#features)
|
|
* [Overview](#overview)
|
|
* [Usage](#usage)
|
|
* [Customizing](#customizing)
|
|
* [inputs](#inputs)
|
|
* [outputs](#outputs)
|
|
* [Notes](#notes)
|
|
* [Latest tag](#latest-tag)
|
|
* [Coerces Git tag](#coerces-git-tag)
|
|
* [Templates available for schedule tag](#templates-available-for-schedule-tag)
|
|
* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
|
|
* [How can I help?](#how-can-i-help)
|
|
* [License](#license)
|
|
|
|
## Features
|
|
|
|
* Docker tags generated from GitHub action event and Git metadata
|
|
* [OCI Image Format Specification](https://github.com/opencontainers/image-spec/blob/master/annotations.md) used to generate Docker labels
|
|
* [Handlebars template](https://handlebarsjs.com/guide/) to apply to schedule tag
|
|
|
|
## Overview
|
|
|
|
| Event | Ref | Commit SHA | Docker Tags |
|
|
|-----------------|-------------------------------|------------|-------------------------------------|
|
|
| `schedule` | `refs/heads/master` | `45f132a` | `sha-45f132a`, `nightly` |
|
|
| `pull_request` | `refs/pull/2/merge` | `a123b57` | `sha-a123b57`, `pr-2` |
|
|
| `push` | `refs/heads/<default_branch>` | `676cae2` | `sha-676cae2`, `edge` |
|
|
| `push` | `refs/heads/dev` | `cf20257` | `sha-cf20257`, `dev` |
|
|
| `push` | `refs/heads/my/branch` | `a5df687` | `sha-a5df687`, `my-branch` |
|
|
| `push tag` | `refs/tags/v1.2.3` | `bf4565b` | `sha-bf4565b`, `1.2.3`, `latest` |
|
|
| `push tag` | `refs/tags/mytag` | `afb7833` | `sha-afb7833`, `mytag` |
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
name: ci
|
|
|
|
on:
|
|
schedule:
|
|
- cron: '0 10 * * *' # everyday at 10am
|
|
push:
|
|
branches:
|
|
- '**'
|
|
tags:
|
|
- 'v*.*.*'
|
|
pull_request:
|
|
|
|
jobs:
|
|
docker:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
-
|
|
name: Checkout
|
|
uses: actions/checkout@v2
|
|
-
|
|
name: Docker meta
|
|
id: docker_meta
|
|
uses: crazy-max/ghaction-docker-meta@v1
|
|
with:
|
|
images: |
|
|
name/app
|
|
ghcr.io/name/app
|
|
tag-sha: true
|
|
-
|
|
name: Set up QEMU
|
|
uses: docker/setup-qemu-action@v1
|
|
-
|
|
name: Set up Docker Buildx
|
|
uses: docker/setup-buildx-action@v1
|
|
-
|
|
name: Login to DockerHub
|
|
if: github.event_name != 'pull_request'
|
|
uses: docker/login-action@v1
|
|
with:
|
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
|
-
|
|
name: Build and push
|
|
uses: docker/build-push-action@v2
|
|
with:
|
|
context: .
|
|
file: ./Dockerfile
|
|
platforms: linux/amd64,linux/arm64,linux/386
|
|
push: ${{ github.event_name != 'pull_request' }}
|
|
tags: ${{ steps.docker_meta.outputs.tags }}
|
|
labels: ${{ steps.docker_meta.outputs.labels }}
|
|
```
|
|
|
|
## Customizing
|
|
|
|
### inputs
|
|
|
|
Following inputs can be used as `step.with` keys
|
|
|
|
| Name | Type | Description |
|
|
|---------------------|----------|------------------------------------|
|
|
| `images` | List/CSV | List of Docker images to use as base name for tags |
|
|
| `tag-sha` | Bool | Add git short SHA as Docker tag (default `false`) |
|
|
| `tag-edge` | Bool | Enable edge branch tagging (default `false`) |
|
|
| `tag-edge-branch` | String | Branch that will be tagged as edge (default `repo.default_branch`) |
|
|
| `tag-coerce-tag` | String | Coerces Git tag to semver if possible using [Handlebars template](https://handlebarsjs.com/guide/) |
|
|
| `tag-schedule` | String | [Handlebars template](https://handlebarsjs.com/guide/) to apply to schedule tag (default `nightly`) |
|
|
| `sep-tags` | String | Separator to use for tags output (default `\n`) |
|
|
| `sep-labels` | String | Separator to use for labels output (default `\n`) |
|
|
|
|
> List/CSV type can be a newline or comma delimited string
|
|
|
|
### outputs
|
|
|
|
Following outputs are available
|
|
|
|
| Name | Type | Description |
|
|
|---------------|---------|---------------------------------------|
|
|
| `version` | String | Generated Docker image version |
|
|
| `tags` | String | Generated Docker tags |
|
|
| `labels` | String | Generated Docker labels |
|
|
|
|
## Notes
|
|
|
|
### Latest tag
|
|
|
|
`latest` tag is created only on `push tag` event and resolves one of the following conditions:
|
|
|
|
* Git tag is a valid [semver](https://semver.org/)
|
|
* Provided `tag-coerce-tag` is valid
|
|
|
|
### Coerces Git tag
|
|
|
|
Provides a very forgiving translation of a non-semver tag to semver. For more information see
|
|
[Coercion section](https://www.npmjs.com/package/semver#coercion). `tag-coerce-tag` supports
|
|
[Handlebars template](https://handlebarsjs.com/guide/) with the following inputs:
|
|
|
|
| `tag-coerce-tag` | Git tag | Version |
|
|
|-------------------------|----------|---------|
|
|
| `{{raw}}` | `v1.2.3` | `1.2.3` |
|
|
| `{{major}}.{{minor}}` | `v1.2.3` | `1.2` |
|
|
| `{{major}}` | `v1.2.3` | `1` |
|
|
| `{{minor}}` | `v1.2.3` | `2` |
|
|
| `{{patch}}` | `v1.2.3` | `3` |
|
|
|
|
### Templates available for schedule tag
|
|
|
|
`tag-schedule` is specially crafted input to support [Handlebars template](https://handlebarsjs.com/guide/) with
|
|
the following expressions:
|
|
|
|
| Expression | Example | Description |
|
|
|-------------------------|-------------------------------------------|------------------------------------------|
|
|
| `{{date 'format'}}` | `{{date 'YYYYMMDD'}}` > `20200110` | Render date by its [moment format](https://momentjs.com/docs/#/displaying/format/)
|
|
|
|
You can find more examples in the [CI workflow](.github/workflows/ci.yml).
|
|
|
|
## Keep up-to-date with GitHub Dependabot
|
|
|
|
Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)
|
|
has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem),
|
|
to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file:
|
|
|
|
```yaml
|
|
version: 2
|
|
updates:
|
|
# Maintain dependencies for GitHub Actions
|
|
- package-ecosystem: "github-actions"
|
|
directory: "/"
|
|
schedule:
|
|
interval: "daily"
|
|
```
|
|
|
|
## How can I help?
|
|
|
|
All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2:
|
|
the project, or to raise issues :speech_balloon: You can also support this project by
|
|
[**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) :clap: or by making a
|
|
[Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely! :rocket:
|
|
|
|
Thanks again for your support, it is much appreciated! :pray:
|
|
|
|
## License
|
|
|
|
MIT. See `LICENSE` for more details.
|