Compare commits

...

28 Commits

Author SHA1 Message Date
CrazyMax
8adbcfe00d Update CHANGELOG 2020-11-18 00:40:29 +01:00
CrazyMax
1c9398a965 Missing input in action.yml 2020-11-18 00:39:59 +01:00
CrazyMax
9fad2f37d6 Update CI workflow 2020-11-18 00:32:35 +01:00
CrazyMax
7ef05591b5 Update CHANGELOG 2020-11-17 23:34:01 +01:00
CrazyMax
e8ce48988f Handle semver tags (#14)
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2020-11-17 22:31:03 +00:00
CrazyMax
009f84cd69 Use major version of actions 2020-11-08 02:54:03 +01:00
CrazyMax
dd2e615c98 Fix tests 2020-10-31 20:21:22 +01:00
CrazyMax
f552880d7c Update CHANGELOG 2020-10-31 20:18:48 +01:00
CrazyMax
8d7fa04f07 Use repo.html_url for org.opencontainers.image.source label to be able to display README on GHCR 2020-10-31 20:16:51 +01:00
CrazyMax
52c4b1ad0c Handle tag-match-latest on Git tag event (#8)
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2020-10-31 18:52:55 +00:00
CrazyMax
b4c9b2116e Update README 2020-10-28 20:04:33 +01:00
CrazyMax
5c140cfb94 Update CHANGELOG 2020-10-28 18:27:31 +01:00
CrazyMax
6cc07472c0 Generate latest tag by default on push tag event (#5)
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2020-10-28 17:25:31 +00:00
CrazyMax
5ecce77816 Update README 2020-10-27 15:16:46 +01:00
CrazyMax
741aa98f85 Overwrite labels note 2020-10-27 14:13:48 +01:00
CrazyMax
4a3b775794 Update README 2020-10-27 03:01:36 +01:00
CrazyMax
6fe5b3f6bb Add tag-match-group input to choose group to get if tag-match matches
Check tag-match is a valid regex
2020-10-27 02:32:26 +01:00
CrazyMax
ad83daa929 Fix workflow 2020-10-27 01:05:40 +01:00
CrazyMax
a207508e20 Update CHANGELOG 2020-10-27 00:59:19 +01:00
CrazyMax
983124bca8 Use RegExp to match against a Git tag instead of coerce 2020-10-27 00:57:32 +01:00
CrazyMax
4a3aaf409c Update README 2020-10-26 17:58:13 +01:00
CrazyMax
0c4748bf65 Update cron 2020-10-26 17:54:22 +01:00
CrazyMax
ffb794a3fd Update CHANGELOG 2020-10-26 17:53:34 +01:00
CrazyMax
0dac4059e9 Set latest tag only if matches with a pattern 2020-10-26 17:51:00 +01:00
dependabot[bot]
4d7603f754 Bump codecov/codecov-action from v1.0.13 to v1.0.14 (#4)
Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from v1.0.13 to v1.0.14.
- [Release notes](https://github.com/codecov/codecov-action/releases)
- [Commits](https://github.com/codecov/codecov-action/compare/v1.0.13...7d5dfa54903bd909319c580a00535b483d1efcf3)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-10-26 11:37:33 +00:00
CrazyMax
06c67913f5 Update README 2020-10-26 01:51:56 +01:00
CrazyMax
1c62cbada4 Update CHANGELOG 2020-10-26 01:44:06 +01:00
CrazyMax
5bc3bf6dce Coerces Git tag to semver (#3)
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2020-10-26 00:39:21 +00:00
16 changed files with 1454 additions and 531 deletions

View File

@@ -2,7 +2,7 @@ name: ci
on: on:
schedule: schedule:
- cron: '0 * * * *' # every hours - cron: '0 */4 * * *' # every 4 hours
push: push:
branches: branches:
- '**' - '**'
@@ -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,6 +53,49 @@ jobs:
tag-sha: true tag-sha: true
tag-schedule: ${{ matrix.tag-schedule }} tag-schedule: ${{ matrix.tag-schedule }}
tag-match:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include:
- tag-match: '\d{1,3}.\d{1,3}.\d{1,3}'
tag-match-group: '0'
- tag-match: '\d{1,3}.\d{1,3}'
tag-match-group: '0'
- tag-match: 'v(.*)'
tag-match-group: '1'
steps:
-
name: Checkout
uses: actions/checkout@v2
-
name: Docker meta
uses: ./
with:
images: |
${{ env.DOCKER_IMAGE }}
ghcr.io/name/app
tag-sha: true
tag-match: ${{ matrix.tag-match }}
tag-match-group: ${{ matrix.tag-match-group }}
tag-semver:
runs-on: ubuntu-latest
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}}
docker-push: docker-push:
runs-on: ubuntu-latest runs-on: ubuntu-latest
services: services:
@@ -63,15 +106,15 @@ 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-match: '\d{1,3}.\d{1,3}.\d{1,3}'
- -
name: Set up QEMU name: Set up QEMU
uses: docker/setup-qemu-action@v1 uses: docker/setup-qemu-action@v1

View File

@@ -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

View File

@@ -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.13 uses: codecov/codecov-action@v1
if: success() if: success()
with: with:
token: ${{ secrets.CODECOV_TOKEN }} token: ${{ secrets.CODECOV_TOKEN }}

View File

@@ -1,5 +1,39 @@
# Changelog # Changelog
## 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)
* Set latest tag only if matches with a pattern
## 1.2.0 (2020/10/26)
* Coerces Git tag to semver (#3)
## 1.1.0 (2020/10/25) ## 1.1.0 (2020/10/25)
* Allow to templatize schedule tag (#1) * Allow to templatize schedule tag (#1)

232
README.md
View File

@@ -17,13 +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)
* [Templates available for schedule tag](#templates-available-for-schedule-tag) * [Latest tag](#latest-tag)
* [`tag-match` examples](#tag-match-examples)
* [Handle semver tag](#handle-semver-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)
@@ -34,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` | | `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:
@@ -73,10 +75,134 @@ 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
tag-sha: true 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-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 name: Set up QEMU
uses: docker/setup-qemu-action@v1 uses: docker/setup-qemu-action@v1
@@ -114,7 +240,11 @@ 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-schedule` | String | [Handlebars template](https://handlebarsjs.com/guide/) to apply to schedule tag (default `nightly`) | | `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-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-schedule` | String | [Template](#schedule-tag) to apply to schedule tag (default `nightly`) |
| `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`) |
@@ -132,7 +262,43 @@ Following outputs are available
## Notes ## Notes
### Templates available for schedule tag ### Latest 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
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
| Git tag | `tag-match` | `tag-match-group` | Match | Docker tags |
|-------------------------|------------------------------------|-------------------|----------------------|---------------------------|
| `v1.2.3` | `\d{1,3}.\d{1,3}.\d{1,3}` | `0` | :white_check_mark: | `1.2.3`, `latest` |
| `v2.0.8-beta.67` | `v(.*)` | `1` | :white_check_mark: | `2.0.8-beta.67`, `latest` |
| `v2.0.8-beta.67` | `v(\d.\d)` | `1` | :white_check_mark: | `2.0`, `latest` |
| `release1` | `\d{1,3}.\d{1,3}` | `0` | :x: | `release1` |
| `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
`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
the following expressions: the following expressions:
@@ -143,6 +309,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)

View File

@@ -0,0 +1,23 @@
GITHUB_ACTION=crazy-maxghaction-dump-context
GITHUB_ACTIONS=true
GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
GITHUB_ACTOR=crazy-max
GITHUB_API_URL=https://api.github.com
GITHUB_BASE_REF=
GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
GITHUB_EVENT_NAME=push
#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
GITHUB_GRAPHQL_URL=https://api.github.com/graphql
GITHUB_HEAD_REF=
GITHUB_JOB=event
GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
GITHUB_REF=refs/tags/20200110-RC2
GITHUB_REPOSITORY=crazy-max/test-docker-action
GITHUB_REPOSITORY_OWNER=crazy-max
GITHUB_RETENTION_DAYS=90
GITHUB_RUN_ID=325968230
GITHUB_RUN_NUMBER=4
GITHUB_SERVER_URL=https://github.com
GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
GITHUB_WORKFLOW=event
GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action

View File

@@ -0,0 +1,23 @@
GITHUB_ACTION=crazy-maxghaction-dump-context
GITHUB_ACTIONS=true
GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
GITHUB_ACTOR=crazy-max
GITHUB_API_URL=https://api.github.com
GITHUB_BASE_REF=
GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
GITHUB_EVENT_NAME=push
#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
GITHUB_GRAPHQL_URL=https://api.github.com/graphql
GITHUB_HEAD_REF=
GITHUB_JOB=event
GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
GITHUB_REF=refs/tags/sometag
GITHUB_REPOSITORY=crazy-max/test-docker-action
GITHUB_REPOSITORY_OWNER=crazy-max
GITHUB_RETENTION_DAYS=90
GITHUB_RUN_ID=325968230
GITHUB_RUN_NUMBER=4
GITHUB_SERVER_URL=https://github.com
GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
GITHUB_WORKFLOW=event
GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action

View File

@@ -0,0 +1,23 @@
GITHUB_ACTION=crazy-maxghaction-dump-context
GITHUB_ACTIONS=true
GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
GITHUB_ACTOR=crazy-max
GITHUB_API_URL=https://api.github.com
GITHUB_BASE_REF=
GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
GITHUB_EVENT_NAME=push
#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
GITHUB_GRAPHQL_URL=https://api.github.com/graphql
GITHUB_HEAD_REF=
GITHUB_JOB=event
GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
GITHUB_REF=refs/tags/v2.0.8-beta.67
GITHUB_REPOSITORY=crazy-max/test-docker-action
GITHUB_REPOSITORY_OWNER=crazy-max
GITHUB_RETENTION_DAYS=90
GITHUB_RUN_ID=325968230
GITHUB_RUN_NUMBER=4
GITHUB_SERVER_URL=https://github.com
GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
GITHUB_WORKFLOW=event
GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action

File diff suppressed because it is too large Load Diff

View File

@@ -21,8 +21,22 @@ 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-semver:
description: 'Handle Git tag as semver template if possible'
required: false
tag-match:
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-match-latest:
description: 'Set latest Docker tag if tag-match matches or on Git tag event'
default: 'true'
required: false
tag-schedule: tag-schedule:
description: 'Handlebars template to apply to schedule tag' description: 'Template to apply to schedule tag'
default: 'nightly' default: 'nightly'
required: false required: false
sep-tags: sep-tags:

139
dist/index.js generated vendored
View File

@@ -25,6 +25,10 @@ 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'),
tagSemver: getInputList('tag-semver'),
tagMatch: core.getInput('tag-match'),
tagMatchGroup: Number(core.getInput('tag-match-group')) || 0,
tagMatchLatest: /true/i.test(core.getInput('tag-match-latest') || 'true'),
tagSchedule: core.getInput('tag-schedule') || 'nightly', tagSchedule: core.getInput('tag-schedule') || 'nightly',
sepTags: core.getInput('sep-tags') || `\n`, sepTags: core.getInput('sep-tags') || `\n`,
sepLabels: core.getInput('sep-labels') || `\n`, sepLabels: core.getInput('sep-labels') || `\n`,
@@ -129,9 +133,9 @@ function run() {
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}`); core.info(version.main || '');
core.endGroup(); core.endGroup();
core.setOutput('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) {
@@ -167,7 +171,6 @@ 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;
@@ -179,40 +182,79 @@ class Meta {
this.date = new Date(); this.date = new Date();
} }
version() { version() {
const currentDate = this.date;
const version = {
main: undefined,
partial: [],
latest: false
};
if (/schedule/.test(this.context.eventName)) { if (/schedule/.test(this.context.eventName)) {
return handlebars.compile(this.inputs.tagSchedule)(this.scheduleTplContext()); version.main = handlebars.compile(this.inputs.tagSchedule)({
date: function (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)) {
return sver ? sver : tag; const sver = semver.parse(version.main, {
} includePrerelease: true
else if (/^refs\/heads\//.test(this.context.ref)) { });
const branch = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-'); version.latest = !semver.prerelease(version.main);
return this.inputs.tagEdge && this.inputs.tagEdgeBranch === branch ? 'edge' : branch; version.main = handlebars.compile(this.inputs.tagSemver[0])(sver);
} if (version.latest) {
else if (/^refs\/pull\//.test(this.context.ref)) { for (const semverTpl of this.inputs.tagSemver) {
const pr = this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, ''); const partial = handlebars.compile(semverTpl)(sver);
return `pr-${pr}`; if (partial == version.main) {
} continue;
} }
tags() { version.partial.push(partial);
let tags = []; }
for (const image of this.inputs.images) { }
if (/schedule/.test(this.context.eventName)) {
tags.push.apply(tags, this.eventSchedule(image));
} }
else if (/^refs\/tags\//.test(this.context.ref)) { else if (this.inputs.tagMatch) {
tags.push.apply(tags, this.eventTag(image)); let tagMatch;
} const isRegEx = this.inputs.tagMatch.match(/^\/(.+)\/(.*)$/);
else if (/^refs\/heads\//.test(this.context.ref)) { if (isRegEx) {
tags.push.apply(tags, this.eventBranch(image)); tagMatch = version.main.match(new RegExp(isRegEx[1], isRegEx[2]));
} }
else if (/^refs\/pull\//.test(this.context.ref)) { else {
tags.push.apply(tags, this.eventPullRequest(image)); tagMatch = version.main.match(this.inputs.tagMatch);
}
if (tagMatch) {
version.main = tagMatch[this.inputs.tagMatchGroup];
version.latest = this.inputs.tagMatchLatest;
}
} }
else { else {
core.warning(`Unknown event "${this.context.eventName}" with ref "${this.context.ref}"`); version.latest = this.inputs.tagMatchLatest;
}
}
else if (/^refs\/heads\//.test(this.context.ref)) {
version.main = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
if (this.inputs.tagEdge && this.inputs.tagEdgeBranch === version.main) {
version.main = 'edge';
}
}
else if (/^refs\/pull\//.test(this.context.ref)) {
version.main = `pr-${this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '')}`;
}
return version;
}
tags() {
const version = this.version();
if (!version.main) {
return [];
}
let tags = [];
for (const image of this.inputs.images) {
tags.push(`${image}:${version.main}`);
for (const partial of version.partial) {
tags.push(`${image}:${partial}`);
}
if (version.latest) {
tags.push(`${image}: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(`${image}:sha-${this.context.sha.substr(0, 7)}`);
@@ -226,44 +268,13 @@ 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() || ''}`, `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) || ''}`
]; ];
} }
eventSchedule(image) {
const schedule = handlebars.compile(this.inputs.tagSchedule)(this.scheduleTplContext());
return [`${image}:${schedule}`];
}
eventTag(image) {
const tag = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
const version = semver.clean(tag);
if (version) {
return [`${image}:${version}`, `${image}:latest`];
}
return [`${image}:${tag}`];
}
eventBranch(image) {
const branch = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
if (this.inputs.tagEdge && this.inputs.tagEdgeBranch === branch) {
return [`${image}:edge`];
}
return [`${image}:${branch}`];
}
eventPullRequest(image) {
const pr = this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '');
return [`${image}:pr-${pr}`];
}
scheduleTplContext() {
const currentDate = this.date;
return {
date: function (format) {
return moment(currentDate).utc().format(format);
}
};
}
} }
exports.Meta = Meta; exports.Meta = Meta;
//# sourceMappingURL=meta.js.map //# sourceMappingURL=meta.js.map

View File

@@ -5,6 +5,10 @@ export interface Inputs {
tagSha: boolean; tagSha: boolean;
tagEdge: boolean; tagEdge: boolean;
tagEdgeBranch: string; tagEdgeBranch: string;
tagSemver: string[];
tagMatch: string;
tagMatchGroup: number;
tagMatchLatest: boolean;
tagSchedule: string; tagSchedule: string;
sepTags: string; sepTags: string;
sepLabels: string; sepLabels: string;
@@ -17,6 +21,10 @@ 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'),
tagMatchGroup: Number(core.getInput('tag-match-group')) || 0,
tagMatchLatest: /true/i.test(core.getInput('tag-match-latest') || 'true'),
tagSchedule: core.getInput('tag-schedule') || 'nightly', tagSchedule: core.getInput('tag-schedule') || 'nightly',
sepTags: core.getInput('sep-tags') || `\n`, sepTags: core.getInput('sep-tags') || `\n`,
sepLabels: core.getInput('sep-labels') || `\n`, sepLabels: core.getInput('sep-labels') || `\n`,

View File

@@ -1,6 +1,6 @@
import {getInputs, Inputs} from './context'; import {getInputs, Inputs} from './context';
import * as github from './github'; import * as github from './github';
import {Meta} from './meta'; import {Meta, Version} from './meta';
import * as core from '@actions/core'; 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';
@@ -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: string | undefined = meta.version(); const version: Version = meta.version();
core.startGroup(`Docker image version`); core.startGroup(`Docker image version`);
core.info(`${version}`); core.info(version.main || '');
core.endGroup(); core.endGroup();
core.setOutput('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`);

View File

@@ -2,10 +2,15 @@ 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 {
main: string | undefined;
partial: string[];
latest: boolean;
}
export class Meta { export class Meta {
private readonly inputs: Inputs; private readonly inputs: Inputs;
private readonly context: Context; private readonly context: Context;
@@ -22,35 +27,78 @@ export class Meta {
this.date = new Date(); this.date = new Date();
} }
public version(): string | undefined { public version(): Version {
const currentDate = this.date;
const version: Version = {
main: undefined,
partial: [],
latest: false
};
if (/schedule/.test(this.context.eventName)) { if (/schedule/.test(this.context.eventName)) {
return handlebars.compile(this.inputs.tagSchedule)(this.scheduleTplContext()); version.main = handlebars.compile(this.inputs.tagSchedule)({
date: function (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)) {
return sver ? sver : tag; 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;
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.tagMatchLatest;
}
} else {
version.latest = this.inputs.tagMatchLatest;
}
} else if (/^refs\/heads\//.test(this.context.ref)) { } else if (/^refs\/heads\//.test(this.context.ref)) {
const branch = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-'); version.main = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
return this.inputs.tagEdge && this.inputs.tagEdgeBranch === branch ? 'edge' : branch; if (this.inputs.tagEdge && this.inputs.tagEdgeBranch === version.main) {
version.main = 'edge';
}
} else if (/^refs\/pull\//.test(this.context.ref)) { } else if (/^refs\/pull\//.test(this.context.ref)) {
const 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 `pr-${pr}`;
} }
return version;
} }
public tags(): Array<string> { public tags(): Array<string> {
const version: Version = this.version();
if (!version.main) {
return [];
}
let tags: Array<string> = []; let tags: Array<string> = [];
for (const image of this.inputs.images) { for (const image of this.inputs.images) {
if (/schedule/.test(this.context.eventName)) { tags.push(`${image}:${version.main}`);
tags.push.apply(tags, this.eventSchedule(image)); for (const partial of version.partial) {
} else if (/^refs\/tags\//.test(this.context.ref)) { tags.push(`${image}:${partial}`);
tags.push.apply(tags, this.eventTag(image)); }
} else if (/^refs\/heads\//.test(this.context.ref)) { if (version.latest) {
tags.push.apply(tags, this.eventBranch(image)); tags.push(`${image}:latest`);
} else if (/^refs\/pull\//.test(this.context.ref)) {
tags.push.apply(tags, this.eventPullRequest(image));
} else {
core.warning(`Unknown event "${this.context.eventName}" with ref "${this.context.ref}"`);
} }
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(`${image}:sha-${this.context.sha.substr(0, 7)}`);
@@ -64,47 +112,11 @@ 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() || ''}`, `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 || ''}`
]; ];
} }
private eventSchedule(image: string): Array<string> {
const schedule = handlebars.compile(this.inputs.tagSchedule)(this.scheduleTplContext());
return [`${image}:${schedule}`];
}
private eventTag(image: string): Array<string> {
const tag = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
const version = semver.clean(tag);
if (version) {
return [`${image}:${version}`, `${image}:latest`];
}
return [`${image}:${tag}`];
}
private eventBranch(image: string): Array<string> {
const branch = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
if (this.inputs.tagEdge && this.inputs.tagEdgeBranch === branch) {
return [`${image}:edge`];
}
return [`${image}:${branch}`];
}
private eventPullRequest(image: string): Array<string> {
const pr = this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '');
return [`${image}:pr-${pr}`];
}
private scheduleTplContext(): any {
const currentDate = this.date;
return {
date: function (format) {
return moment(currentDate).utc().format(format);
}
};
}
} }