actions/docker-metadata-action
1
0
Fork 0
mirror of https://github.com/docker/metadata-action.git synced 2024-12-22 21:35:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Handle semver tags (#14)

Browse source 
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax 2020-11-17 23:31:03 +01:00 committed by GitHub
parent 009f84cd69
commit e8ce48988f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 2573 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

177
README.md
View file

@ -17,14 +17,17 @@ If you are interested, [check out](https://git.io/Je09Y) my other :octocat: GitH
___ ___
* [Features](#features) * [Features](#features)
* [Overview](#overview)
* [Usage](#usage) * [Usage](#usage)
* [Basic](#basic)
* [Semver](#semver)
* [Complete](#complete)
* [Customizing](#customizing) * [Customizing](#customizing)
* [inputs](#inputs) * [inputs](#inputs)
* [outputs](#outputs) * [outputs](#outputs)
* [Notes](#notes) * [Notes](#notes)
* [Latest tag](#latest-tag) * [Latest tag](#latest-tag)
* [`tag-match` examples](#tag-match-examples) * [`tag-match` examples](#tag-match-examples)
* [Handle semver tag](#handle-semver-tag)
* [Schedule tag](#schedule-tag) * [Schedule tag](#schedule-tag)
* [Overwrite labels](#overwrite-labels) * [Overwrite labels](#overwrite-labels)
* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot) * [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
@ -37,29 +40,27 @@ ___
* [OCI Image Format Specification](https://github.com/opencontainers/image-spec/blob/master/annotations.md) used to generate Docker labels * [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 * [Handlebars template](https://handlebarsjs.com/guide/) to apply to schedule tag
## Overview ## Usage
### Basic
| Event | Ref | Commit SHA | Docker Tags | | Event | Ref | Commit SHA | Docker Tags |
|-----------------|-------------------------------|------------|-------------------------------------| |-----------------|-------------------------------|------------|-------------------------------------|
| `schedule` | `refs/heads/master` | `45f132a` | `sha-45f132a`, `nightly` | | `pull_request` | `refs/pull/2/merge` | `a123b57` | `pr-2` |
| `pull_request` | `refs/pull/2/merge` | `a123b57` | `sha-a123b57`, `pr-2` | | `push` | `refs/heads/master` | `cf20257` | `master` |
| `push` | `refs/heads/master` | `cf20257` | `sha-cf20257`, `master` | | `push` | `refs/heads/my/branch` | `a5df687` | `my-branch` |
| `push` | `refs/heads/my/branch` | `a5df687` | `sha-a5df687`, `my-branch` | | `push tag` | `refs/tags/v1.2.3` | `ad132f5` | `v1.2.3`, `latest` |
| `push tag` | `refs/tags/v1.2.3` | `bf4565b` | `sha-bf4565b`, `v1.2.3`, `latest` | | `push tag` | `refs/tags/v2.0.8-beta.67` | `fc89efd` | `v2.0.8-beta.67`, `latest` |
## Usage
```yaml ```yaml
name: ci name: ci
on: on:
schedule:
- cron: '0 10 * * *' # everyday at 10am
push: push:
branches: branches:
- '**' - '**'
tags: tags:
- 'v*.*.*' - 'v*'
pull_request: pull_request:
jobs: jobs:
@ -100,6 +101,133 @@ jobs:
labels: ${{ steps.docker_meta.outputs.labels }} labels: ${{ steps.docker_meta.outputs.labels }}
``` ```
### Semver
| Event | Ref | Commit SHA | Docker Tags |
|-----------------|-------------------------------|------------|-------------------------------------|
| `pull_request` | `refs/pull/2/merge` | `a123b57` | `pr-2` |
| `push` | `refs/heads/master` | `cf20257` | `master` |
| `push` | `refs/heads/my/branch` | `a5df687` | `my-branch` |
| `push tag` | `refs/tags/v1.2.3` | `ad132f5` | `1.2.3`, `1.2`, `latest` |
| `push tag` | `refs/tags/v2.0.8-beta.67` | `fc89efd` | `2.0.8-beta.67` |
```yaml
name: ci
on:
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
tag-semver: |
{{version}}
{{major}}.{{minor}}
-
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 }}
```
### Complete
| Event | Ref | Commit SHA | Docker Tags |
|-----------------|-------------------------------|------------|-----------------------------------------|
| `schedule` | `refs/heads/master` | `45f132a` | `sha-45f132a`, `nightly` |
| `pull_request` | `refs/pull/2/merge` | `a123b57` | `sha-45f132a`, `pr-2` |
| `push` | `refs/heads/master` | `cf20257` | `sha-45f132a`, `master` |
| `push` | `refs/heads/my/branch` | `a5df687` | `sha-45f132a`, `my-branch` |
| `push tag` | `refs/tags/v1.2.3` | `ad132f5` | `sha-45f132a`, `1.2.3`, `1.2`, `latest` |
| `push tag` | `refs/tags/v2.0.8-beta.67` | `fc89efd` | `sha-45f132a`, `2.0.8-beta.67` |
```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
tag-semver: |
{{version}}
{{major}}.{{minor}}
-
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 ## Customizing
### inputs ### inputs
@ -112,6 +240,7 @@ Following inputs can be used as `step.with` keys
| `tag-sha` | Bool | Add git short SHA as Docker tag (default `false`) | | `tag-sha` | Bool | Add git short SHA as Docker tag (default `false`) |
| `tag-edge` | Bool | Enable edge branch tagging (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-edge-branch` | String | Branch that will be tagged as edge (default `repo.default_branch`) |
| `tag-semver` | List | Handle Git tag as semver [template](#handle-semver-tag) if possible |
| `tag-match` | String | RegExp to match against a Git tag and use first match as Docker tag | | `tag-match` | String | RegExp to match against a Git tag and use first match as Docker tag |
| `tag-match-group` | Number | Group to get if `tag-match` matches (default `0`) | | `tag-match-group` | Number | Group to get if `tag-match` matches (default `0`) |
| `tag-match-latest` | Bool | Set `latest` Docker tag if `tag-match` matches or on Git tag event (default `true`) | | `tag-match-latest` | Bool | Set `latest` Docker tag if `tag-match` matches or on Git tag event (default `true`) |
@ -135,9 +264,10 @@ Following outputs are available
### Latest tag ### Latest tag
Latest Docker tag will be generated by default on `push tag` event. So if for example you push the `v1.2.3` Git tag, Latest Docker tag will be generated by default on `push tag` event. If for example you push the `v1.2.3` Git tag,
you will have at the output of this action the Docker tags `v1.2.3` and `latest`. But you can allow the latest tag to be you will have at the output of this action the Docker tags `v1.2.3` and `latest`. But you can allow the latest tag to be
generated only if the Git tag matches a regular expression with the [`tag-match` input](#tag-match-examples). generated only if the Git tag matches a regular expression with the [`tag-match` input](#tag-match-examples) or if
`tag-semver` is valid [semver](https://semver.org/).
### `tag-match` examples ### `tag-match` examples
@ -149,6 +279,25 @@ generated only if the Git tag matches a regular expression with the [`tag-match`
| `release1` | `\d{1,3}.\d{1,3}` | `0` | :x: | `release1` | | `release1` | `\d{1,3}.\d{1,3}` | `0` | :x: | `release1` |
| `20200110-RC2` | `\d+` | `0` | :white_check_mark: | `20200110`, `latest` | | `20200110-RC2` | `\d+` | `0` | :white_check_mark: | `20200110`, `latest` |
### Handle semver tag
If Git tag is a valid [semver](https://semver.org/) you can handle it to output multi Docker tags at once.
`tag-semver` supports multi-line [Handlebars template](https://handlebarsjs.com/guide/) with the following inputs:
| Git tag | `tag-semver` | Valid | Docker tags |
|--------------------|----------------------------------------------------------|--------------------|--------------------|
| `v1.2.3` | `{{raw}}` | :white_check_mark: | `v1.2.3`, `latest` |
| `v1.2.3` | `{{version}}` | :white_check_mark: | `1.2.3`, `latest` |
| `v1.2.3` | `{{major}}.{{minor}}` | :white_check_mark: | `1.2`, `latest` |
| `v1.2.3` | `v{{major}}` | :white_check_mark: | `v1`, `latest` |
| `v1.2.3` | `{{minor}}` | :white_check_mark: | `2`, `latest` |
| `v1.2.3` | `{{patch}}` | :white_check_mark: | `3`, `latest` |
| `v1.2.3` | `{{major}}.{{minor}}`<br>`{{major}}.{{minor}}.{{patch}}` | :white_check_mark: | `1.2`, `1.2.3`, `latest` |
| `v2.0.8-beta.67` | `{{raw}}` | :white_check_mark: | `v2.0.8-beta.67` |
| `v2.0.8-beta.67` | `{{version}}` | :white_check_mark: | `2.0.8-beta.67` |
| `v2.0.8-beta.67` | `{{major}}.{{minor}}` | :white_check_mark: | `2.0` |
| `release1` | `{{raw}}` | :x: | `release1` |
### Schedule tag ### Schedule tag
`tag-schedule` is specially crafted input to support [Handlebars template](https://handlebarsjs.com/guide/) with `tag-schedule` is specially crafted input to support [Handlebars template](https://handlebarsjs.com/guide/) with

222
__tests__/meta.test.ts
View file

@ -66,7 +66,8 @@ describe('null', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: undefined, main: undefined,
partial: [],
latest: false latest: false
} as Version, } as Version,
[], [],
@ -87,7 +88,8 @@ describe('null', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: undefined, main: undefined,
partial: [],
latest: false latest: false
} as Version, } as Version,
[], [],
@ -114,7 +116,8 @@ describe('push', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: 'dev', main: 'dev',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -138,7 +141,8 @@ describe('push', () => {
tagEdge: true, tagEdge: true,
} as Inputs, } as Inputs,
{ {
version: 'edge', main: 'edge',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -161,7 +165,8 @@ describe('push', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: 'master', main: 'master',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -185,7 +190,8 @@ describe('push', () => {
tagEdge: true, tagEdge: true,
} as Inputs, } as Inputs,
{ {
version: 'edge', main: 'edge',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -208,7 +214,8 @@ describe('push', () => {
images: ['org/app', 'ghcr.io/user/app'], images: ['org/app', 'ghcr.io/user/app'],
} as Inputs, } as Inputs,
{ {
version: 'dev', main: 'dev',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -233,7 +240,8 @@ describe('push', () => {
tagEdge: true, tagEdge: true,
} as Inputs, } as Inputs,
{ {
version: 'edge', main: 'edge',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -258,7 +266,8 @@ describe('push', () => {
tagSha: true, tagSha: true,
} as Inputs, } as Inputs,
{ {
version: 'dev', main: 'dev',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -286,7 +295,8 @@ describe('push', () => {
tagEdge: true, tagEdge: true,
} as Inputs, } as Inputs,
{ {
version: 'edge', main: 'edge',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -315,7 +325,8 @@ describe('push', () => {
tagEdgeBranch: 'dev' tagEdgeBranch: 'dev'
} as Inputs, } as Inputs,
{ {
version: 'edge', main: 'edge',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -344,7 +355,8 @@ describe('push', () => {
tagEdgeBranch: 'dev' tagEdgeBranch: 'dev'
} as Inputs, } as Inputs,
{ {
version: 'master', main: 'master',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -376,7 +388,8 @@ describe('push tag', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: 'release1', main: 'release1',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -400,7 +413,8 @@ describe('push tag', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: '20200110-RC2', main: '20200110-RC2',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -426,7 +440,8 @@ describe('push tag', () => {
tagMatchLatest: false, tagMatchLatest: false,
} as Inputs, } as Inputs,
{ {
version: '20200110', main: '20200110',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -452,7 +467,8 @@ describe('push tag', () => {
tagMatchLatest: false, tagMatchLatest: false,
} as Inputs, } as Inputs,
{ {
version: '20200110', main: '20200110',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -476,7 +492,37 @@ describe('push tag', () => {
tagMatch: `\\d{1,3}.\\d{1,3}.\\d{1,3}`, tagMatch: `\\d{1,3}.\\d{1,3}.\\d{1,3}`,
} as Inputs, } as Inputs,
{ {
version: '1.1.1', main: '1.1.1',
partial: [],
latest: true
} as Version,
[
'org/app:1.1.1',
'org/app:latest',
'ghcr.io/user/app:1.1.1',
'ghcr.io/user/app:latest'
],
[
"org.opencontainers.image.title=Hello-World",
"org.opencontainers.image.description=This your first repo!",
"org.opencontainers.image.url=https://github.com/octocat/Hello-World",
"org.opencontainers.image.source=https://github.com/octocat/Hello-World",
"org.opencontainers.image.version=1.1.1",
"org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
"org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
"org.opencontainers.image.licenses=MIT"
]
],
[
'event_tag_v1.1.1.env',
{
images: ['org/app', 'ghcr.io/user/app'],
tagMatch: `^v(\\d{1,3}.\\d{1,3}.\\d{1,3})$`,
tagMatchGroup: 1,
} as Inputs,
{
main: '1.1.1',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -503,7 +549,8 @@ describe('push tag', () => {
tagMatch: `\\d{1,3}.\\d{1,3}.\\d{1,3}-(alpha|beta).\\d{1,3}`, tagMatch: `\\d{1,3}.\\d{1,3}.\\d{1,3}-(alpha|beta).\\d{1,3}`,
} as Inputs, } as Inputs,
{ {
version: '2.0.8-beta.67', main: '2.0.8-beta.67',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -530,7 +577,8 @@ describe('push tag', () => {
tagMatch: `\\d{1,3}.\\d{1,3}`, tagMatch: `\\d{1,3}.\\d{1,3}`,
} as Inputs, } as Inputs,
{ {
version: '2.0', main: '2.0',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -550,6 +598,33 @@ describe('push tag', () => {
"org.opencontainers.image.licenses=MIT" "org.opencontainers.image.licenses=MIT"
] ]
], ],
[
'event_tag_v2.0.8-beta.67.env',
{
images: ['org/app', 'ghcr.io/user/app'],
tagMatch: `^v(\\d{1,3}.\\d{1,3}.\\d{1,3})$`,
tagMatchGroup: 1,
} as Inputs,
{
main: 'v2.0.8-beta.67',
partial: [],
latest: false
} as Version,
[
'org/app:v2.0.8-beta.67',
'ghcr.io/user/app:v2.0.8-beta.67'
],
[
"org.opencontainers.image.title=Hello-World",
"org.opencontainers.image.description=This your first repo!",
"org.opencontainers.image.url=https://github.com/octocat/Hello-World",
"org.opencontainers.image.source=https://github.com/octocat/Hello-World",
"org.opencontainers.image.version=v2.0.8-beta.67",
"org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
"org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
"org.opencontainers.image.licenses=MIT"
]
],
[ [
'event_tag_sometag.env', 'event_tag_sometag.env',
{ {
@ -557,7 +632,8 @@ describe('push tag', () => {
tagMatch: `\\d{1,3}.\\d{1,3}`, tagMatch: `\\d{1,3}.\\d{1,3}`,
} as Inputs, } as Inputs,
{ {
version: 'sometag', main: 'sometag',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -575,6 +651,64 @@ describe('push tag', () => {
"org.opencontainers.image.licenses=MIT" "org.opencontainers.image.licenses=MIT"
] ]
], ],
[
'event_tag_v1.1.1.env',
{
images: ['org/app', 'ghcr.io/user/app'],
tagSemver: ['{{version}}', '{{major}}.{{minor}}', '{{major}}'],
} as Inputs,
{
main: '1.1.1',
partial: ['1.1', '1'],
latest: true
} as Version,
[
'org/app:1.1.1',
'org/app:1.1',
'org/app:1',
'org/app:latest',
'ghcr.io/user/app:1.1.1',
'ghcr.io/user/app:1.1',
'ghcr.io/user/app:1',
'ghcr.io/user/app:latest'
],
[
"org.opencontainers.image.title=Hello-World",
"org.opencontainers.image.description=This your first repo!",
"org.opencontainers.image.url=https://github.com/octocat/Hello-World",
"org.opencontainers.image.source=https://github.com/octocat/Hello-World",
"org.opencontainers.image.version=1.1.1",
"org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
"org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
"org.opencontainers.image.licenses=MIT"
]
],
[
'event_tag_v2.0.8-beta.67.env',
{
images: ['org/app', 'ghcr.io/user/app'],
tagSemver: ['{{version}}', '{{major}}.{{minor}}', '{{major}}'],
} as Inputs,
{
main: '2.0.8-beta.67',
partial: [],
latest: false
} as Version,
[
'org/app:2.0.8-beta.67',
'ghcr.io/user/app:2.0.8-beta.67'
],
[
"org.opencontainers.image.title=Hello-World",
"org.opencontainers.image.description=This your first repo!",
"org.opencontainers.image.url=https://github.com/octocat/Hello-World",
"org.opencontainers.image.source=https://github.com/octocat/Hello-World",
"org.opencontainers.image.version=2.0.8-beta.67",
"org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
"org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
"org.opencontainers.image.licenses=MIT"
]
],
])('given %p event ', tagsLabelsTest); ])('given %p event ', tagsLabelsTest);
}); });
@ -588,7 +722,8 @@ describe('latest', () => {
tagMatch: `^release\\d{1,2}`, tagMatch: `^release\\d{1,2}`,
} as Inputs, } as Inputs,
{ {
version: 'release1', main: 'release1',
partial: [],
latest: true, latest: true,
} as Version, } as Version,
[ [
@ -613,7 +748,8 @@ describe('latest', () => {
tagMatch: `^\\d+-RC\\d{1,2}`, tagMatch: `^\\d+-RC\\d{1,2}`,
} as Inputs, } as Inputs,
{ {
version: '20200110-RC2', main: '20200110-RC2',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -638,7 +774,8 @@ describe('latest', () => {
tagMatch: `\\d{8}`, tagMatch: `\\d{8}`,
} as Inputs, } as Inputs,
{ {
version: '20200110', main: '20200110',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -663,7 +800,8 @@ describe('latest', () => {
tagMatch: `\\d{1,3}.\\d{1,3}.\\d{1,3}`, tagMatch: `\\d{1,3}.\\d{1,3}.\\d{1,3}`,
} as Inputs, } as Inputs,
{ {
version: '1.1.1', main: '1.1.1',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -687,7 +825,8 @@ describe('latest', () => {
images: ['org/app', 'ghcr.io/user/app'], images: ['org/app', 'ghcr.io/user/app'],
} as Inputs, } as Inputs,
{ {
version: 'v1.1.1', main: 'v1.1.1',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -714,7 +853,8 @@ describe('latest', () => {
tagMatch: `\\d{1,3}.\\d{1,3}.\\d{1,3}`, tagMatch: `\\d{1,3}.\\d{1,3}.\\d{1,3}`,
} as Inputs, } as Inputs,
{ {
version: '2.0.8', main: '2.0.8',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [
@ -741,7 +881,8 @@ describe('latest', () => {
tagMatchLatest: false, tagMatchLatest: false,
} as Inputs, } as Inputs,
{ {
version: 'v1.1.1', main: 'v1.1.1',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -771,7 +912,8 @@ describe('pull_request', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: 'pr-2', main: 'pr-2',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -794,7 +936,8 @@ describe('pull_request', () => {
images: ['org/app', 'ghcr.io/user/app'], images: ['org/app', 'ghcr.io/user/app'],
} as Inputs, } as Inputs,
{ {
version: 'pr-2', main: 'pr-2',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -819,7 +962,8 @@ describe('pull_request', () => {
tagSha: true, tagSha: true,
} as Inputs, } as Inputs,
{ {
version: 'pr-2', main: 'pr-2',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -851,7 +995,8 @@ describe('schedule', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: 'nightly', main: 'nightly',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -875,7 +1020,8 @@ describe('schedule', () => {
tagSchedule: `{{date 'YYYYMMDD'}}` tagSchedule: `{{date 'YYYYMMDD'}}`
} as Inputs, } as Inputs,
{ {
version: '20200110', main: '20200110',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -899,7 +1045,8 @@ describe('schedule', () => {
tagSchedule: `{{date 'YYYYMMDD-HHmmss'}}` tagSchedule: `{{date 'YYYYMMDD-HHmmss'}}`
} as Inputs, } as Inputs,
{ {
version: '20200110-003000', main: '20200110-003000',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -922,7 +1069,8 @@ describe('schedule', () => {
images: ['org/app', 'ghcr.io/user/app'], images: ['org/app', 'ghcr.io/user/app'],
} as Inputs, } as Inputs,
{ {
version: 'nightly', main: 'nightly',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -947,7 +1095,8 @@ describe('schedule', () => {
tagSha: true, tagSha: true,
} as Inputs, } as Inputs,
{ {
version: 'nightly', main: 'nightly',
partial: [],
latest: false latest: false
} as Version, } as Version,
[ [
@ -979,7 +1128,8 @@ describe('release', () => {
images: ['user/app'], images: ['user/app'],
} as Inputs, } as Inputs,
{ {
version: 'v1.1.1', main: 'v1.1.1',
partial: [],
latest: true latest: true
} as Version, } as Version,
[ [

2198
dist/index.js generated vendored
View file

File diff suppressed because it is too large Load diff

3
package.json
View file

@ -26,7 +26,8 @@
"@actions/core": "^1.2.6", "@actions/core": "^1.2.6",
"@actions/github": "^4.0.0", "@actions/github": "^4.0.0",
"handlebars": "^4.7.6", "handlebars": "^4.7.6",
"moment": "^2.29.1" "moment": "^2.29.1",
"semver": "^7.3.2"
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "^26.0.0", "@types/jest": "^26.0.0",

2
src/context.ts
View file

@ -5,6 +5,7 @@ export interface Inputs {
tagSha: boolean; tagSha: boolean;
tagEdge: boolean; tagEdge: boolean;
tagEdgeBranch: string; tagEdgeBranch: string;
tagSemver: string[];
tagMatch: string; tagMatch: string;
tagMatchGroup: number; tagMatchGroup: number;
tagMatchLatest: boolean; tagMatchLatest: boolean;
@ -20,6 +21,7 @@ export function getInputs(): Inputs {
tagSha: /true/i.test(core.getInput('tag-sha') || 'false'), tagSha: /true/i.test(core.getInput('tag-sha') || 'false'),
tagEdge: /true/i.test(core.getInput('tag-edge') || 'false'), tagEdge: /true/i.test(core.getInput('tag-edge') || 'false'),
tagEdgeBranch: core.getInput('tag-edge-branch'), tagEdgeBranch: core.getInput('tag-edge-branch'),
tagSemver: getInputList('tag-semver'),
tagMatch: core.getInput('tag-match'), tagMatch: core.getInput('tag-match'),
tagMatchGroup: Number(core.getInput('tag-match-group')) || 0, tagMatchGroup: Number(core.getInput('tag-match-group')) || 0,
tagMatchLatest: /true/i.test(core.getInput('tag-match-latest') || 'true'), tagMatchLatest: /true/i.test(core.getInput('tag-match-latest') || 'true'),

4
src/main.ts
View file

@ -29,9 +29,9 @@ async function run() {
const version: Version = meta.version(); const version: Version = meta.version();
core.startGroup(`Docker image version`); core.startGroup(`Docker image version`);
core.info(version.version || ''); core.info(version.main || '');
core.endGroup(); core.endGroup();
core.setOutput('version', version.version || ''); core.setOutput('version', version.main || '');
const tags: Array<string> = meta.tags(); const tags: Array<string> = meta.tags();
core.startGroup(`Docker tags`); core.startGroup(`Docker tags`);

51
src/meta.ts
View file

@ -1,11 +1,13 @@
import * as handlebars from 'handlebars'; import * as handlebars from 'handlebars';
import * as moment from 'moment'; import * as moment from 'moment';
import * as semver from 'semver';
import {Inputs} from './context'; import {Inputs} from './context';
import {Context} from '@actions/github/lib/context'; import {Context} from '@actions/github/lib/context';
import {ReposGetResponseData} from '@octokit/types'; import {ReposGetResponseData} from '@octokit/types';
export interface Version { export interface Version {
version: string | undefined; main: string | undefined;
partial: string[];
latest: boolean; latest: boolean;
} }
@ -28,40 +30,56 @@ export class Meta {
public version(): Version { public version(): Version {
const currentDate = this.date; const currentDate = this.date;
const version: Version = { const version: Version = {
version: undefined, main: undefined,
partial: [],
latest: false latest: false
}; };
if (/schedule/.test(this.context.eventName)) { if (/schedule/.test(this.context.eventName)) {
version.version = handlebars.compile(this.inputs.tagSchedule)({ version.main = handlebars.compile(this.inputs.tagSchedule)({
date: function (format) { date: function (format) {
return moment(currentDate).utc().format(format); return moment(currentDate).utc().format(format);
} }
}); });
} else if (/^refs\/tags\//.test(this.context.ref)) { } else if (/^refs\/tags\//.test(this.context.ref)) {
version.version = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-'); version.main = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
if (this.inputs.tagMatch) { if (this.inputs.tagSemver.length > 0 && semver.valid(version.main)) {
const sver = semver.parse(version.main, {
includePrerelease: true
});
version.latest = !semver.prerelease(version.main);
version.main = handlebars.compile(this.inputs.tagSemver[0])(sver);
if (version.latest) {
for (const semverTpl of this.inputs.tagSemver) {
const partial = handlebars.compile(semverTpl)(sver);
if (partial == version.main) {
continue;
}
version.partial.push(partial);
}
}
} else if (this.inputs.tagMatch) {
let tagMatch; let tagMatch;
const isRegEx = this.inputs.tagMatch.match(/^\/(.+)\/(.*)$/); const isRegEx = this.inputs.tagMatch.match(/^\/(.+)\/(.*)$/);
if (isRegEx) { if (isRegEx) {
tagMatch = version.version.match(new RegExp(isRegEx[1], isRegEx[2])); tagMatch = version.main.match(new RegExp(isRegEx[1], isRegEx[2]));
} else { } else {
tagMatch = version.version.match(this.inputs.tagMatch); tagMatch = version.main.match(this.inputs.tagMatch);
} }
if (tagMatch) { if (tagMatch) {
version.version = tagMatch[this.inputs.tagMatchGroup]; version.main = tagMatch[this.inputs.tagMatchGroup];
version.latest = this.inputs.tagMatchLatest; version.latest = this.inputs.tagMatchLatest;
} }
} else { } else {
version.latest = this.inputs.tagMatchLatest; version.latest = this.inputs.tagMatchLatest;
} }
} else if (/^refs\/heads\//.test(this.context.ref)) { } else if (/^refs\/heads\//.test(this.context.ref)) {
version.version = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-'); version.main = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
if (this.inputs.tagEdge && this.inputs.tagEdgeBranch === version.version) { if (this.inputs.tagEdge && this.inputs.tagEdgeBranch === version.main) {
version.version = 'edge'; version.main = 'edge';
} }
} else if (/^refs\/pull\//.test(this.context.ref)) { } else if (/^refs\/pull\//.test(this.context.ref)) {
version.version = `pr-${this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '')}`; version.main = `pr-${this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '')}`;
} }
return version; return version;
@ -69,13 +87,16 @@ export class Meta {
public tags(): Array<string> { public tags(): Array<string> {
const version: Version = this.version(); const version: Version = this.version();
if (!version.version) { if (!version.main) {
return []; return [];
} }
let tags: Array<string> = []; let tags: Array<string> = [];
for (const image of this.inputs.images) { for (const image of this.inputs.images) {
tags.push(`${image}:${version.version}`); tags.push(`${image}:${version.main}`);
for (const partial of version.partial) {
tags.push(`${image}:${partial}`);
}
if (version.latest) { if (version.latest) {
tags.push(`${image}:latest`); tags.push(`${image}:latest`);
} }
@ -92,7 +113,7 @@ export class Meta {
`org.opencontainers.image.description=${this.repo.description || ''}`, `org.opencontainers.image.description=${this.repo.description || ''}`,
`org.opencontainers.image.url=${this.repo.html_url || ''}`, `org.opencontainers.image.url=${this.repo.html_url || ''}`,
`org.opencontainers.image.source=${this.repo.html_url || ''}`, `org.opencontainers.image.source=${this.repo.html_url || ''}`,
`org.opencontainers.image.version=${this.version().version || ''}`, `org.opencontainers.image.version=${this.version().main || ''}`,
`org.opencontainers.image.created=${this.date.toISOString()}`, `org.opencontainers.image.created=${this.date.toISOString()}`,
`org.opencontainers.image.revision=${this.context.sha || ''}`, `org.opencontainers.image.revision=${this.context.sha || ''}`,
`org.opencontainers.image.licenses=${this.repo.license?.spdx_id || ''}` `org.opencontainers.image.licenses=${this.repo.license?.spdx_id || ''}`