Compare commits
37 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
b747b8aaa7 | ||
|
585ab8356c | ||
|
9de4428611 | ||
|
4c2760ba7a | ||
|
ef12c77b87 | ||
|
c53f88523a | ||
|
6b4bf4724e | ||
|
d48c7d2917 | ||
|
7cb65aaacb | ||
|
0dca12c226 | ||
|
6f270f37d4 | ||
|
2860e42b1f | ||
|
6a86fe1739 | ||
|
86dc87790d | ||
|
b3281c85e6 | ||
|
9ba75ef142 | ||
|
a017e545d7 | ||
|
8adbcfe00d | ||
|
1c9398a965 | ||
|
9fad2f37d6 | ||
|
7ef05591b5 | ||
|
e8ce48988f | ||
|
009f84cd69 | ||
|
dd2e615c98 | ||
|
f552880d7c | ||
|
8d7fa04f07 | ||
|
52c4b1ad0c | ||
|
b4c9b2116e | ||
|
5c140cfb94 | ||
|
6cc07472c0 | ||
|
5ecce77816 | ||
|
741aa98f85 | ||
|
4a3b775794 | ||
|
6fe5b3f6bb | ||
|
ad83daa929 | ||
|
a207508e20 | ||
|
983124bca8 |
56
.github/workflows/ci.yml
vendored
56
.github/workflows/ci.yml
vendored
@@ -19,7 +19,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2.3.3
|
uses: actions/checkout@v2
|
||||||
-
|
-
|
||||||
name: Docker meta
|
name: Docker meta
|
||||||
uses: ./
|
uses: ./
|
||||||
@@ -42,7 +42,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2.3.3
|
uses: actions/checkout@v2
|
||||||
-
|
-
|
||||||
name: Docker meta
|
name: Docker meta
|
||||||
uses: ./
|
uses: ./
|
||||||
@@ -53,19 +53,22 @@ jobs:
|
|||||||
tag-sha: true
|
tag-sha: true
|
||||||
tag-schedule: ${{ matrix.tag-schedule }}
|
tag-schedule: ${{ matrix.tag-schedule }}
|
||||||
|
|
||||||
coerce:
|
tag-match:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
tag-coerce-tag:
|
include:
|
||||||
- "{{raw}}"
|
- tag-match: '\d{1,3}.\d{1,3}.\d{1,3}'
|
||||||
- "{{major}}.{{minor}}"
|
tag-match-group: '0'
|
||||||
- "{{patch}}"
|
- tag-match: '\d{1,3}.\d{1,3}'
|
||||||
|
tag-match-group: '0'
|
||||||
|
- tag-match: 'v(.*)'
|
||||||
|
tag-match-group: '1'
|
||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2.3.3
|
uses: actions/checkout@v2
|
||||||
-
|
-
|
||||||
name: Docker meta
|
name: Docker meta
|
||||||
uses: ./
|
uses: ./
|
||||||
@@ -73,8 +76,34 @@ jobs:
|
|||||||
images: |
|
images: |
|
||||||
${{ env.DOCKER_IMAGE }}
|
${{ env.DOCKER_IMAGE }}
|
||||||
ghcr.io/name/app
|
ghcr.io/name/app
|
||||||
tag-coerce-tag: ${{ matrix.tag-coerce-tag }}
|
|
||||||
tag-sha: true
|
tag-sha: true
|
||||||
|
tag-match: ${{ matrix.tag-match }}
|
||||||
|
tag-match-group: ${{ matrix.tag-match-group }}
|
||||||
|
|
||||||
|
tag-semver:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
tag-latest:
|
||||||
|
- 'true'
|
||||||
|
- 'false'
|
||||||
|
steps:
|
||||||
|
-
|
||||||
|
name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
-
|
||||||
|
name: Docker meta
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
images: |
|
||||||
|
${{ env.DOCKER_IMAGE }}
|
||||||
|
ghcr.io/name/app
|
||||||
|
tag-semver: |
|
||||||
|
{{raw}}
|
||||||
|
{{version}}
|
||||||
|
{{major}}.{{minor}}.{{patch}}
|
||||||
|
tag-latest: ${{ matrix.tag-latest }}
|
||||||
|
|
||||||
docker-push:
|
docker-push:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -86,15 +115,18 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2.3.3
|
uses: actions/checkout@v2
|
||||||
-
|
-
|
||||||
name: Docker meta
|
name: Docker meta
|
||||||
id: docker_meta
|
id: docker_meta
|
||||||
uses: ./
|
uses: ./
|
||||||
with:
|
with:
|
||||||
images: |
|
images: ${{ env.DOCKER_IMAGE }}
|
||||||
${{ env.DOCKER_IMAGE }}
|
|
||||||
tag-sha: true
|
tag-sha: true
|
||||||
|
tag-semver: |
|
||||||
|
v{{version}}
|
||||||
|
v{{major}}.{{minor}}
|
||||||
|
v{{major}}
|
||||||
-
|
-
|
||||||
name: Set up QEMU
|
name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v1
|
uses: docker/setup-qemu-action@v1
|
||||||
|
4
.github/workflows/labels.yml
vendored
4
.github/workflows/labels.yml
vendored
@@ -14,7 +14,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2.3.3
|
uses: actions/checkout@v2
|
||||||
-
|
-
|
||||||
name: Run Labeler
|
name: Run Labeler
|
||||||
uses: crazy-max/ghaction-github-labeler@v3.1.0
|
uses: crazy-max/ghaction-github-labeler@v3
|
||||||
|
6
.github/workflows/test.yml
vendored
6
.github/workflows/test.yml
vendored
@@ -17,7 +17,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2.3.3
|
uses: actions/checkout@v2
|
||||||
-
|
-
|
||||||
name: Validate
|
name: Validate
|
||||||
run: docker buildx bake validate
|
run: docker buildx bake validate
|
||||||
@@ -30,7 +30,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v2.3.3
|
uses: actions/checkout@v2
|
||||||
-
|
-
|
||||||
name: Install
|
name: Install
|
||||||
run: yarn install
|
run: yarn install
|
||||||
@@ -39,7 +39,7 @@ jobs:
|
|||||||
run: yarn run test
|
run: yarn run test
|
||||||
-
|
-
|
||||||
name: Upload coverage
|
name: Upload coverage
|
||||||
uses: codecov/codecov-action@v1.0.14
|
uses: codecov/codecov-action@v1
|
||||||
if: success()
|
if: success()
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
token: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
49
CHANGELOG.md
49
CHANGELOG.md
@@ -1,5 +1,54 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 1.9.0 (2020/12/04)
|
||||||
|
|
||||||
|
* Allow to add custom tags (#24)
|
||||||
|
* Allow to disable latest tag (#23)
|
||||||
|
* Warn on invalid semver (#22)
|
||||||
|
* Avoid unnecessary calls to version (#21)
|
||||||
|
|
||||||
|
## 1.8.5 (2020/11/24)
|
||||||
|
|
||||||
|
* Use sepLabels when joining labels for output (#17)
|
||||||
|
|
||||||
|
## 1.8.4 (2020/11/20)
|
||||||
|
|
||||||
|
* Pre-release (rc, beta, alpha) will only extend `{{version}}` as tag for `tag-semver`
|
||||||
|
|
||||||
|
## 1.8.3 (2020/11/20)
|
||||||
|
|
||||||
|
* Lowercase image name (#16)
|
||||||
|
|
||||||
|
## 1.8.2 (2020/11/18)
|
||||||
|
|
||||||
|
* Remove duplicated tags
|
||||||
|
|
||||||
|
## 1.8.1 (2020/11/18)
|
||||||
|
|
||||||
|
* Missing input in `action.yml`
|
||||||
|
|
||||||
|
## 1.8.0 (2020/11/17)
|
||||||
|
|
||||||
|
* Handle semver tags (#14)
|
||||||
|
|
||||||
|
## 1.7.0 (2020/10/31)
|
||||||
|
|
||||||
|
* Use `repo.html_url` for `org.opencontainers.image.source` label to be able to display README on GHCR
|
||||||
|
* Handle `tag-match-latest` on Git tag event (#8)
|
||||||
|
|
||||||
|
## 1.6.0 (2020/10/28)
|
||||||
|
|
||||||
|
* Generate latest tag by default on push tag event (#5)
|
||||||
|
|
||||||
|
## 1.5.0 (2020/10/27)
|
||||||
|
|
||||||
|
* Add `tag-match-group` input to choose group to get if `tag-match` matches
|
||||||
|
* Check `tag-match` is a valid regex
|
||||||
|
|
||||||
|
## 1.4.0 (2020/10/27)
|
||||||
|
|
||||||
|
* Use RegExp to match against a Git tag instead of coerce
|
||||||
|
|
||||||
## 1.3.0 (2020/10/26)
|
## 1.3.0 (2020/10/26)
|
||||||
|
|
||||||
* Set latest tag only if matches with a pattern
|
* Set latest tag only if matches with a pattern
|
||||||
|
241
README.md
241
README.md
@@ -17,15 +17,19 @@ 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)
|
||||||
* [Coerces Git tag](#coerces-git-tag)
|
* [Handle semver tag](#handle-semver-tag)
|
||||||
|
* [`tag-match` examples](#tag-match-examples)
|
||||||
* [Schedule tag](#schedule-tag)
|
* [Schedule tag](#schedule-tag)
|
||||||
|
* [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)
|
||||||
* [How can I help?](#how-can-i-help)
|
* [How can I help?](#how-can-i-help)
|
||||||
* [License](#license)
|
* [License](#license)
|
||||||
@@ -36,31 +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/<default_branch>` | `676cae2` | `sha-676cae2`, `edge` |
|
| `push` | `refs/heads/my/branch` | `a5df687` | `my-branch` |
|
||||||
| `push` | `refs/heads/dev` | `cf20257` | `sha-cf20257`, `dev` |
|
| `push tag` | `refs/tags/v1.2.3` | `ad132f5` | `v1.2.3`, `latest` |
|
||||||
| `push` | `refs/heads/my/branch` | `a5df687` | `sha-a5df687`, `my-branch` |
|
| `push tag` | `refs/tags/v2.0.8-beta.67` | `fc89efd` | `v2.0.8-beta.67`, `latest` |
|
||||||
| `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
|
```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:
|
||||||
@@ -75,10 +75,135 @@ jobs:
|
|||||||
id: docker_meta
|
id: docker_meta
|
||||||
uses: crazy-max/ghaction-docker-meta@v1
|
uses: crazy-max/ghaction-docker-meta@v1
|
||||||
with:
|
with:
|
||||||
images: |
|
images: name/app
|
||||||
name/app
|
-
|
||||||
ghcr.io/name/app
|
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 }}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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-a123b57`, `pr-2` |
|
||||||
|
| `push` | `refs/heads/master` | `cf20257` | `sha-cf20257`, `master` |
|
||||||
|
| `push` | `refs/heads/my/branch` | `a5df687` | `sha-a5df687`, `my-branch` |
|
||||||
|
| `push tag` | `refs/tags/v1.2.3` | `ad132f5` | `sha-ad132f5`, `1.2.3`, `1.2`, `latest` |
|
||||||
|
| `push tag` | `refs/tags/v2.0.8-beta.67` | `fc89efd` | `sha-fc89efd`, `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-sha: true
|
tag-sha: true
|
||||||
|
tag-semver: |
|
||||||
|
{{version}}
|
||||||
|
{{major}}.{{minor}}
|
||||||
-
|
-
|
||||||
name: Set up QEMU
|
name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v1
|
uses: docker/setup-qemu-action@v1
|
||||||
@@ -116,14 +241,20 @@ 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-coerce-tag` | String | Coerces Git tag to semver if possible using [template](#coerces-git-tag) |
|
| `tag-semver` | List/CSV | Handle Git tag as semver [template](#handle-semver-tag) if possible |
|
||||||
| `tag-latest-match` | String | Set `latest` tag only if [matches with a pattern](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) |
|
| `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-latest` | Bool | Set `latest` Docker tag if `tag-semver`, `tag-match` or Git tag event occurs (default `true`) |
|
||||||
| `tag-schedule` | String | [Template](#schedule-tag) to apply to schedule tag (default `nightly`) |
|
| `tag-schedule` | String | [Template](#schedule-tag) to apply to schedule tag (default `nightly`) |
|
||||||
|
| `tag-custom` | List/CSV | List of custom tags |
|
||||||
|
| `tag-custom-only` | Bool | Only use `tag-custom` as Docker tags |
|
||||||
| `sep-tags` | String | Separator to use for tags output (default `\n`) |
|
| `sep-tags` | String | Separator to use for tags output (default `\n`) |
|
||||||
| `sep-labels` | String | Separator to use for labels 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
|
> List/CSV type can be a newline or comma delimited string
|
||||||
|
|
||||||
|
> `tag-semver` and `tag-match` are mutually exclusive
|
||||||
|
|
||||||
### outputs
|
### outputs
|
||||||
|
|
||||||
Following outputs are available
|
Following outputs are available
|
||||||
@@ -138,26 +269,44 @@ Following outputs are available
|
|||||||
|
|
||||||
### Latest tag
|
### Latest tag
|
||||||
|
|
||||||
`latest` tag is created with the following conditions:
|
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
|
||||||
|
generated only if `tag-semver` is a valid [semver](https://semver.org/) or if Git tag matches a regular expression
|
||||||
|
with the [`tag-match` input](#tag-match-examples). Can be disabled if `tag-latest` is `false`.
|
||||||
|
|
||||||
* Git tag is a valid [semver](https://semver.org/)
|
### Handle semver tag
|
||||||
* Provided `tag-coerce-tag` is valid
|
|
||||||
|
|
||||||
If `tag-latest-match` is filled, then it has priority over the creation of the 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:
|
||||||
|
|
||||||
### Coerces Git tag
|
| Git tag | `tag-semver` | Valid | Output tags | Output version |
|
||||||
|
|--------------------|----------------------------------------------------------|--------------------|----------------------------|------------------------------|
|
||||||
|
| `v1.2.3` | `{{raw}}` | :white_check_mark: | `v1.2.3`, `latest` | `v1.2.3` |
|
||||||
|
| `v1.2.3` | `{{version}}` | :white_check_mark: | `1.2.3`, `latest` | `1.2.3` |
|
||||||
|
| `v1.2.3` | `{{major}}.{{minor}}` | :white_check_mark: | `1.2`, `latest` | `1.2` |
|
||||||
|
| `v1.2.3` | `v{{major}}` | :white_check_mark: | `v1`, `latest` | `v1` |
|
||||||
|
| `v1.2.3` | `{{minor}}` | :white_check_mark: | `2`, `latest` | `2` |
|
||||||
|
| `v1.2.3` | `{{patch}}` | :white_check_mark: | `3`, `latest` | `3` |
|
||||||
|
| `v1.2.3` | `{{major}}.{{minor}}`<br>`{{major}}.{{minor}}.{{patch}}` | :white_check_mark: | `1.2`, `1.2.3`, `latest` | `1.2`* |
|
||||||
|
| `v2.0.8-beta.67` | `{{raw}}` | :white_check_mark: | `2.0.8-beta.67`** | `2.0.8-beta.67` |
|
||||||
|
| `v2.0.8-beta.67` | `{{version}}` | :white_check_mark: | `2.0.8-beta.67` | `2.0.8-beta.67` |
|
||||||
|
| `v2.0.8-beta.67` | `{{major}}.{{minor}}` | :white_check_mark: | `2.0.8-beta.67`** | `2.0.8-beta.67` |
|
||||||
|
| `release1` | `{{raw}}` | :x: | `release1` | `release1` |
|
||||||
|
|
||||||
Provides a very forgiving translation of a non-semver tag to semver. For more information see
|
> *First occurrence of `tag-semver` will be taken as `output.version`
|
||||||
[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 |
|
> **Pre-release (rc, beta, alpha) will only extend `{{version}}` as tag because they are updated frequently,
|
||||||
|-------------------------|----------|---------|
|
> and contain many breaking changes that are (by the author's design) not yet fit for public consumption.
|
||||||
| `{{raw}}` | `v1.2.3` | `1.2.3` |
|
|
||||||
| `{{major}}.{{minor}}` | `v1.2.3` | `1.2` |
|
### `tag-match` examples
|
||||||
| `{{major}}` | `v1.2.3` | `1` |
|
|
||||||
| `{{minor}}` | `v1.2.3` | `2` |
|
| Git tag | `tag-match` | `tag-match-group` | Match | Output tags | Output version |
|
||||||
| `{{patch}}` | `v1.2.3` | `3` |
|
|-------------------------|------------------------------------|-------------------|----------------------|---------------------------|------------------------------|
|
||||||
|
| `v1.2.3` | `\d{1,3}.\d{1,3}.\d{1,3}` | `0` | :white_check_mark: | `1.2.3`, `latest` | `1.2.3` |
|
||||||
|
| `v2.0.8-beta.67` | `v(.*)` | `1` | :white_check_mark: | `2.0.8-beta.67`, `latest` | `2.0.8-beta.67` |
|
||||||
|
| `v2.0.8-beta.67` | `v(\d.\d)` | `1` | :white_check_mark: | `2.0`, `latest` | `2.0` |
|
||||||
|
| `release1` | `\d{1,3}.\d{1,3}` | `0` | :x: | `release1` | `release1` |
|
||||||
|
| `20200110-RC2` | `\d+` | `0` | :white_check_mark: | `20200110`, `latest` | `20200110` |
|
||||||
|
|
||||||
### Schedule tag
|
### Schedule tag
|
||||||
|
|
||||||
@@ -170,6 +319,28 @@ the following expressions:
|
|||||||
|
|
||||||
You can find more examples in the [CI workflow](.github/workflows/ci.yml).
|
You can find more examples in the [CI workflow](.github/workflows/ci.yml).
|
||||||
|
|
||||||
|
### Overwrite labels
|
||||||
|
|
||||||
|
If some of the [OCI Image Format Specification](https://github.com/opencontainers/image-spec/blob/master/annotations.md)
|
||||||
|
labels generated are not suitable, you can overwrite them like this:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
-
|
||||||
|
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 }}
|
||||||
|
org.opencontainers.image.title=MyCustomTitle
|
||||||
|
org.opencontainers.image.description=Another description
|
||||||
|
org.opencontainers.image.vendor=MyCompany
|
||||||
|
```
|
||||||
|
|
||||||
## Keep up-to-date with GitHub Dependabot
|
## 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)
|
Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)
|
||||||
|
File diff suppressed because it is too large
Load Diff
27
action.yml
27
action.yml
@@ -21,16 +21,35 @@ inputs:
|
|||||||
tag-edge-branch:
|
tag-edge-branch:
|
||||||
description: 'Branch that will be tagged as edge (default repo.default_branch)'
|
description: 'Branch that will be tagged as edge (default repo.default_branch)'
|
||||||
required: false
|
required: false
|
||||||
tag-coerce-tag:
|
tag-semver:
|
||||||
description: 'Coerces Git tag to semver if possible using template'
|
description: 'Handle Git tag as semver template if possible'
|
||||||
required: false
|
required: false
|
||||||
tag-latest-match:
|
tag-match:
|
||||||
description: 'Set latest tag only if matches with a pattern'
|
description: 'RegExp to match against a Git tag and use match group as Docker tag'
|
||||||
|
required: false
|
||||||
|
tag-match-group:
|
||||||
|
description: 'Group to get if tag-match matches (default 0)'
|
||||||
|
default: '0'
|
||||||
|
required: false
|
||||||
|
tag-latest:
|
||||||
|
description: 'Set latest Docker tag if tag-semver, tag-match or Git tag event occurs'
|
||||||
|
default: 'true'
|
||||||
|
required: false
|
||||||
|
tag-match-latest:
|
||||||
|
deprecationMessage: 'tag-match-latest is deprecated. Use tag-latest instead'
|
||||||
|
description: '(DEPRECATED) Set latest Docker tag if tag-match matches or on Git tag event'
|
||||||
|
default: 'true'
|
||||||
required: false
|
required: false
|
||||||
tag-schedule:
|
tag-schedule:
|
||||||
description: 'Template to apply to schedule tag'
|
description: 'Template to apply to schedule tag'
|
||||||
default: 'nightly'
|
default: 'nightly'
|
||||||
required: false
|
required: false
|
||||||
|
tag-custom:
|
||||||
|
description: 'List of custom tags'
|
||||||
|
required: false
|
||||||
|
tag-custom-only:
|
||||||
|
description: 'Only use tag-custom as Docker tags'
|
||||||
|
required: false
|
||||||
sep-tags:
|
sep-tags:
|
||||||
description: 'Separator to use for tags output (default \n)'
|
description: 'Separator to use for tags output (default \n)'
|
||||||
required: false
|
required: false
|
||||||
|
117
dist/index.js
generated
vendored
117
dist/index.js
generated
vendored
@@ -25,9 +25,13 @@ function getInputs() {
|
|||||||
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'),
|
||||||
tagCoerceTag: core.getInput('tag-coerce-tag'),
|
tagSemver: getInputList('tag-semver'),
|
||||||
tagLatestMatch: core.getInput('tag-latest-match'),
|
tagMatch: core.getInput('tag-match'),
|
||||||
|
tagMatchGroup: Number(core.getInput('tag-match-group')) || 0,
|
||||||
|
tagLatest: /true/i.test(core.getInput('tag-latest') || core.getInput('tag-match-latest') || 'true'),
|
||||||
tagSchedule: core.getInput('tag-schedule') || 'nightly',
|
tagSchedule: core.getInput('tag-schedule') || 'nightly',
|
||||||
|
tagCustom: getInputList('tag-custom'),
|
||||||
|
tagCustomOnly: /true/i.test(core.getInput('tag-custom-only') || 'false'),
|
||||||
sepTags: core.getInput('sep-tags') || `\n`,
|
sepTags: core.getInput('sep-tags') || `\n`,
|
||||||
sepLabels: core.getInput('sep-labels') || `\n`,
|
sepLabels: core.getInput('sep-labels') || `\n`,
|
||||||
githubToken: core.getInput('github-token')
|
githubToken: core.getInput('github-token')
|
||||||
@@ -129,11 +133,11 @@ function run() {
|
|||||||
core.info(`runId: ${context.runId}`);
|
core.info(`runId: ${context.runId}`);
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
const meta = new meta_1.Meta(inputs, context, repo);
|
const meta = new meta_1.Meta(inputs, context, repo);
|
||||||
const version = meta.version();
|
const 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 = meta.tags();
|
const tags = meta.tags();
|
||||||
core.startGroup(`Docker tags`);
|
core.startGroup(`Docker tags`);
|
||||||
for (let tag of tags) {
|
for (let tag of tags) {
|
||||||
@@ -147,7 +151,7 @@ function run() {
|
|||||||
core.info(label);
|
core.info(label);
|
||||||
}
|
}
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
core.setOutput('labels', labels.join(inputs.sepTags));
|
core.setOutput('labels', labels.join(inputs.sepLabels));
|
||||||
}
|
}
|
||||||
catch (error) {
|
catch (error) {
|
||||||
core.setFailed(error.message);
|
core.setFailed(error.message);
|
||||||
@@ -169,6 +173,7 @@ exports.Meta = void 0;
|
|||||||
const handlebars = __webpack_require__(7492);
|
const handlebars = __webpack_require__(7492);
|
||||||
const moment = __webpack_require__(9623);
|
const moment = __webpack_require__(9623);
|
||||||
const semver = __webpack_require__(1383);
|
const semver = __webpack_require__(1383);
|
||||||
|
const core = __webpack_require__(2186);
|
||||||
class Meta {
|
class Meta {
|
||||||
constructor(inputs, context, repo) {
|
constructor(inputs, context, repo) {
|
||||||
this.inputs = inputs;
|
this.inputs = inputs;
|
||||||
@@ -178,74 +183,104 @@ class Meta {
|
|||||||
this.context = context;
|
this.context = context;
|
||||||
this.repo = repo;
|
this.repo = repo;
|
||||||
this.date = new Date();
|
this.date = new Date();
|
||||||
|
this.version = this.getVersion();
|
||||||
}
|
}
|
||||||
version() {
|
getVersion() {
|
||||||
var _a;
|
|
||||||
const currentDate = this.date;
|
const currentDate = this.date;
|
||||||
const version = {
|
let 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)) {
|
||||||
const tag = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
|
version.main = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
|
||||||
const sver = semver.clean(tag);
|
if (this.inputs.tagSemver.length > 0 && !semver.valid(version.main)) {
|
||||||
if (this.inputs.tagCoerceTag) {
|
core.warning(`${version.main} is not a valid semver. More info: https://semver.org/`);
|
||||||
const coerce = semver.coerce(tag);
|
|
||||||
if (coerce) {
|
|
||||||
version.version = handlebars.compile(this.inputs.tagCoerceTag)(coerce);
|
|
||||||
version.latest = true;
|
|
||||||
}
|
}
|
||||||
else if (sver) {
|
if (this.inputs.tagSemver.length > 0 && semver.valid(version.main)) {
|
||||||
version.version = sver;
|
const sver = semver.parse(version.main, {
|
||||||
version.latest = true;
|
includePrerelease: true
|
||||||
|
});
|
||||||
|
if (semver.prerelease(version.main)) {
|
||||||
|
version.main = handlebars.compile('{{version}}')(sver);
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
version.version = tag;
|
version.latest = this.inputs.tagLatest;
|
||||||
|
version.main = handlebars.compile(this.inputs.tagSemver[0])(sver);
|
||||||
|
for (const semverTpl of this.inputs.tagSemver) {
|
||||||
|
const partial = handlebars.compile(semverTpl)(sver);
|
||||||
|
if (partial == version.main) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
version.partial.push(partial);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else if (sver) {
|
}
|
||||||
version.version = sver;
|
else if (this.inputs.tagMatch) {
|
||||||
version.latest = true;
|
let tagMatch;
|
||||||
|
const isRegEx = this.inputs.tagMatch.match(/^\/(.+)\/(.*)$/);
|
||||||
|
if (isRegEx) {
|
||||||
|
tagMatch = version.main.match(new RegExp(isRegEx[1], isRegEx[2]));
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
version.version = tag;
|
tagMatch = version.main.match(this.inputs.tagMatch);
|
||||||
|
}
|
||||||
|
if (tagMatch) {
|
||||||
|
version.main = tagMatch[this.inputs.tagMatchGroup];
|
||||||
|
version.latest = this.inputs.tagLatest;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
version.latest = this.inputs.tagLatest;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
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, '')}`;
|
||||||
}
|
}
|
||||||
if (this.inputs.tagLatestMatch) {
|
if (this.inputs.tagCustom.length > 0) {
|
||||||
const match = (_a = version.version) === null || _a === void 0 ? void 0 : _a.match(new RegExp(this.inputs.tagLatestMatch));
|
if (this.inputs.tagCustomOnly) {
|
||||||
version.latest = match !== null;
|
version = {
|
||||||
|
main: this.inputs.tagCustom.shift(),
|
||||||
|
partial: this.inputs.tagCustom,
|
||||||
|
latest: false
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
else {
|
||||||
|
version.partial.push(...this.inputs.tagCustom);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
version.partial = version.partial.filter((item, index) => version.partial.indexOf(item) === index);
|
||||||
return version;
|
return version;
|
||||||
}
|
}
|
||||||
tags() {
|
tags() {
|
||||||
const version = this.version();
|
if (!this.version.main) {
|
||||||
if (!version.version) {
|
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
let tags = [];
|
let tags = [];
|
||||||
for (const image of this.inputs.images) {
|
for (const image of this.inputs.images) {
|
||||||
tags.push(`${image}:${version.version}`);
|
const imageLc = image.toLowerCase();
|
||||||
if (version.latest) {
|
tags.push(`${imageLc}:${this.version.main}`);
|
||||||
tags.push(`${image}:latest`);
|
for (const partial of this.version.partial) {
|
||||||
|
tags.push(`${imageLc}:${partial}`);
|
||||||
|
}
|
||||||
|
if (this.version.latest) {
|
||||||
|
tags.push(`${imageLc}:latest`);
|
||||||
}
|
}
|
||||||
if (this.context.sha && this.inputs.tagSha) {
|
if (this.context.sha && this.inputs.tagSha) {
|
||||||
tags.push(`${image}:sha-${this.context.sha.substr(0, 7)}`);
|
tags.push(`${imageLc}:sha-${this.context.sha.substr(0, 7)}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return tags;
|
return tags;
|
||||||
@@ -256,8 +291,8 @@ class Meta {
|
|||||||
`org.opencontainers.image.title=${this.repo.name || ''}`,
|
`org.opencontainers.image.title=${this.repo.name || ''}`,
|
||||||
`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.clone_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=${((_a = this.repo.license) === null || _a === void 0 ? void 0 : _a.spdx_id) || ''}`
|
`org.opencontainers.image.licenses=${((_a = this.repo.license) === null || _a === void 0 ? void 0 : _a.spdx_id) || ''}`
|
||||||
|
@@ -5,9 +5,13 @@ export interface Inputs {
|
|||||||
tagSha: boolean;
|
tagSha: boolean;
|
||||||
tagEdge: boolean;
|
tagEdge: boolean;
|
||||||
tagEdgeBranch: string;
|
tagEdgeBranch: string;
|
||||||
tagCoerceTag: string;
|
tagSemver: string[];
|
||||||
tagLatestMatch: string;
|
tagMatch: string;
|
||||||
|
tagMatchGroup: number;
|
||||||
|
tagLatest: boolean;
|
||||||
tagSchedule: string;
|
tagSchedule: string;
|
||||||
|
tagCustom: string[];
|
||||||
|
tagCustomOnly: boolean;
|
||||||
sepTags: string;
|
sepTags: string;
|
||||||
sepLabels: string;
|
sepLabels: string;
|
||||||
githubToken: string;
|
githubToken: string;
|
||||||
@@ -19,9 +23,13 @@ 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'),
|
||||||
tagCoerceTag: core.getInput('tag-coerce-tag'),
|
tagSemver: getInputList('tag-semver'),
|
||||||
tagLatestMatch: core.getInput('tag-latest-match'),
|
tagMatch: core.getInput('tag-match'),
|
||||||
|
tagMatchGroup: Number(core.getInput('tag-match-group')) || 0,
|
||||||
|
tagLatest: /true/i.test(core.getInput('tag-latest') || core.getInput('tag-match-latest') || 'true'),
|
||||||
tagSchedule: core.getInput('tag-schedule') || 'nightly',
|
tagSchedule: core.getInput('tag-schedule') || 'nightly',
|
||||||
|
tagCustom: getInputList('tag-custom'),
|
||||||
|
tagCustomOnly: /true/i.test(core.getInput('tag-custom-only') || 'false'),
|
||||||
sepTags: core.getInput('sep-tags') || `\n`,
|
sepTags: core.getInput('sep-tags') || `\n`,
|
||||||
sepLabels: core.getInput('sep-labels') || `\n`,
|
sepLabels: core.getInput('sep-labels') || `\n`,
|
||||||
githubToken: core.getInput('github-token')
|
githubToken: core.getInput('github-token')
|
||||||
|
@@ -27,11 +27,11 @@ async function run() {
|
|||||||
|
|
||||||
const meta: Meta = new Meta(inputs, context, repo);
|
const meta: Meta = new Meta(inputs, context, repo);
|
||||||
|
|
||||||
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`);
|
||||||
@@ -47,7 +47,7 @@ async function run() {
|
|||||||
core.info(label);
|
core.info(label);
|
||||||
}
|
}
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
core.setOutput('labels', labels.join(inputs.sepTags));
|
core.setOutput('labels', labels.join(inputs.sepLabels));
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
core.setFailed(error.message);
|
core.setFailed(error.message);
|
||||||
}
|
}
|
||||||
|
106
src/meta.ts
106
src/meta.ts
@@ -2,15 +2,19 @@ import * as handlebars from 'handlebars';
|
|||||||
import * as moment from 'moment';
|
import * as moment from 'moment';
|
||||||
import * as semver from 'semver';
|
import * as semver from 'semver';
|
||||||
import {Inputs} from './context';
|
import {Inputs} from './context';
|
||||||
|
import * as core from '@actions/core';
|
||||||
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;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Meta {
|
export class Meta {
|
||||||
|
public readonly version: Version;
|
||||||
|
|
||||||
private readonly inputs: Inputs;
|
private readonly inputs: Inputs;
|
||||||
private readonly context: Context;
|
private readonly context: Context;
|
||||||
private readonly repo: ReposGetResponseData;
|
private readonly repo: ReposGetResponseData;
|
||||||
@@ -24,72 +28,102 @@ export class Meta {
|
|||||||
this.context = context;
|
this.context = context;
|
||||||
this.repo = repo;
|
this.repo = repo;
|
||||||
this.date = new Date();
|
this.date = new Date();
|
||||||
|
this.version = this.getVersion();
|
||||||
}
|
}
|
||||||
|
|
||||||
public version(): Version {
|
private getVersion(): Version {
|
||||||
const currentDate = this.date;
|
const currentDate = this.date;
|
||||||
const version: Version = {
|
let 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)) {
|
||||||
const tag = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
|
version.main = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
|
||||||
const sver = semver.clean(tag);
|
if (this.inputs.tagSemver.length > 0 && !semver.valid(version.main)) {
|
||||||
if (this.inputs.tagCoerceTag) {
|
core.warning(`${version.main} is not a valid semver. More info: https://semver.org/`);
|
||||||
const coerce = semver.coerce(tag);
|
|
||||||
if (coerce) {
|
|
||||||
version.version = handlebars.compile(this.inputs.tagCoerceTag)(coerce);
|
|
||||||
version.latest = true;
|
|
||||||
} else if (sver) {
|
|
||||||
version.version = sver;
|
|
||||||
version.latest = true;
|
|
||||||
} else {
|
|
||||||
version.version = tag;
|
|
||||||
}
|
}
|
||||||
} else if (sver) {
|
if (this.inputs.tagSemver.length > 0 && semver.valid(version.main)) {
|
||||||
version.version = sver;
|
const sver = semver.parse(version.main, {
|
||||||
version.latest = true;
|
includePrerelease: true
|
||||||
|
});
|
||||||
|
if (semver.prerelease(version.main)) {
|
||||||
|
version.main = handlebars.compile('{{version}}')(sver);
|
||||||
} else {
|
} else {
|
||||||
version.version = tag;
|
version.latest = this.inputs.tagLatest;
|
||||||
|
version.main = handlebars.compile(this.inputs.tagSemver[0])(sver);
|
||||||
|
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;
|
||||||
|
const isRegEx = this.inputs.tagMatch.match(/^\/(.+)\/(.*)$/);
|
||||||
|
if (isRegEx) {
|
||||||
|
tagMatch = version.main.match(new RegExp(isRegEx[1], isRegEx[2]));
|
||||||
|
} else {
|
||||||
|
tagMatch = version.main.match(this.inputs.tagMatch);
|
||||||
|
}
|
||||||
|
if (tagMatch) {
|
||||||
|
version.main = tagMatch[this.inputs.tagMatchGroup];
|
||||||
|
version.latest = this.inputs.tagLatest;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
version.latest = this.inputs.tagLatest;
|
||||||
}
|
}
|
||||||
} 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, '')}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (this.inputs.tagLatestMatch) {
|
if (this.inputs.tagCustom.length > 0) {
|
||||||
const match = version.version?.match(new RegExp(this.inputs.tagLatestMatch));
|
if (this.inputs.tagCustomOnly) {
|
||||||
version.latest = match !== null;
|
version = {
|
||||||
|
main: this.inputs.tagCustom.shift(),
|
||||||
|
partial: this.inputs.tagCustom,
|
||||||
|
latest: false
|
||||||
|
};
|
||||||
|
} else {
|
||||||
|
version.partial.push(...this.inputs.tagCustom);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
version.partial = version.partial.filter((item, index) => version.partial.indexOf(item) === index);
|
||||||
return version;
|
return version;
|
||||||
}
|
}
|
||||||
|
|
||||||
public tags(): Array<string> {
|
public tags(): Array<string> {
|
||||||
const version: Version = this.version();
|
if (!this.version.main) {
|
||||||
if (!version.version) {
|
|
||||||
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}`);
|
const imageLc = image.toLowerCase();
|
||||||
if (version.latest) {
|
tags.push(`${imageLc}:${this.version.main}`);
|
||||||
tags.push(`${image}:latest`);
|
for (const partial of this.version.partial) {
|
||||||
|
tags.push(`${imageLc}:${partial}`);
|
||||||
|
}
|
||||||
|
if (this.version.latest) {
|
||||||
|
tags.push(`${imageLc}:latest`);
|
||||||
}
|
}
|
||||||
if (this.context.sha && this.inputs.tagSha) {
|
if (this.context.sha && this.inputs.tagSha) {
|
||||||
tags.push(`${image}:sha-${this.context.sha.substr(0, 7)}`);
|
tags.push(`${imageLc}:sha-${this.context.sha.substr(0, 7)}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return tags;
|
return tags;
|
||||||
@@ -100,8 +134,8 @@ export class Meta {
|
|||||||
`org.opencontainers.image.title=${this.repo.name || ''}`,
|
`org.opencontainers.image.title=${this.repo.name || ''}`,
|
||||||
`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.clone_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 || ''}`
|
||||||
|
Reference in New Issue
Block a user