Update CHANGELOG

Add test
Lowercase only on image name (#16 )
2020-11-20 20:26:04 +01:00 · 2020-11-20 16:30:57 +01:00 · 2020-11-20 16:19:08 +01:00 · 2020-11-20 15:54:36 +01:00 · 2020-11-18 17:56:39 +01:00 · 2020-11-18 16:57:42 +01:00
18 changed files with 15695 additions and 453 deletions
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -2,7 +2,7 @@ name: ci

 on:
  schedule:
-    - cron: '0 10 * * 0' # everyday sunday at 10am
+    - cron: '0 */4 * * *' # every 4 hours
  push:
    branches:
      - '**'
@@ -19,10 +19,9 @@ jobs:
    steps:
      -
        name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v2
      -
        name: Docker meta
-        id: docker_meta
        uses: ./
        with:
          images: |
@@ -30,6 +29,73 @@ jobs:
            ghcr.io/name/app
          tag-sha: true

+  tag-schedule:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        tag-schedule:
+          - ""
+          - "cron-{{date 'YYYYMMDD'}}"
+          - "{{date 'YYYYMMDD-HHmmss'}}"
+          - "schedule"
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Docker meta
+        uses: ./
+        with:
+          images: |
+            ${{ env.DOCKER_IMAGE }}
+            ghcr.io/name/app
+          tag-sha: true
+          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:
    runs-on: ubuntu-latest
    services:
@@ -40,15 +106,15 @@ jobs:
    steps:
      -
        name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v2
      -
        name: Docker meta
        id: docker_meta
        uses: ./
        with:
-          images: |
-            ${{ env.DOCKER_IMAGE }}
+          images: ${{ env.DOCKER_IMAGE }}
          tag-sha: true
+          tag-match: '\d{1,3}.\d{1,3}.\d{1,3}'
      -
        name: Set up QEMU
        uses: docker/setup-qemu-action@v1
--- a/.github/workflows/labels.yml
+++ b/.github/workflows/labels.yml
@@ -14,7 +14,7 @@ jobs:
    steps:
      -
        name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v2
      -
        name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v3.1.0
+        uses: crazy-max/ghaction-github-labeler@v3
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -17,7 +17,7 @@ jobs:
    steps:
      -
        name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v2
      -
        name: Validate
        run: docker buildx bake validate
@@ -26,18 +26,11 @@ jobs:
        run: docker buildx bake test

  test:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-          - ubuntu-latest
-          - macOS-latest
-          - windows-latest
+    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v2
      -
        name: Install
        run: yarn install
@@ -46,7 +39,7 @@ jobs:
        run: yarn run test
      -
        name: Upload coverage
-        uses: codecov/codecov-action@v1.0.13
+        uses: codecov/codecov-action@v1
        if: success()
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,52 @@
 # Changelog

+## 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)
+
+* 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)
+
+* Allow to templatize schedule tag (#1)
+* Allow to disable edge branch tagging (#2)
+
 ## 1.0.0 (2020/10/25)

 * Initial version
--- a/README.md
+++ b/README.md
@@ -18,9 +18,18 @@ ___

 * [Features](#features)
 * [Usage](#usage)
+  * [Basic](#basic)
+  * [Semver](#semver)
+  * [Complete](#complete)
 * [Customizing](#customizing)
  * [inputs](#inputs)
  * [outputs](#outputs)
+* [Notes](#notes)
+  * [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)
 * [How can I help?](#how-can-i-help)
 * [License](#license)
@@ -29,30 +38,29 @@ ___

 * Docker tags generated from GitHub action event and Git metadata
 * [OCI Image Format Specification](https://github.com/opencontainers/image-spec/blob/master/annotations.md) used to generate Docker labels
+* [Handlebars template](https://handlebarsjs.com/guide/) to apply to schedule tag

 ## Usage

-| Event           | Ref                           | Commit SHA | Docker Tag                         | Pushed |
-|-----------------|-------------------------------|------------|------------------------------------|--------|
-| `schedule`      |                               |            | `nightly`                          | Yes    |
-| `pull_request`  | `refs/pull/2/merge`           | `a123b57`  | `sha-a123b57`, `pr-2`              | No     |
-| `push`          | `refs/heads/<default_branch>` | `676cae2`  | `sha-676cae2`, `edge`              | Yes    |
-| `push`          | `refs/heads/dev`              | `cf20257`  | `sha-cf20257`, `dev`               | Yes    |
-| `push`          | `refs/heads/my/branch`        | `a5df687`  | `sha-a5df687`, `my-branch`         | Yes    |
-| `push tag`      | `refs/tags/v1.2.3`            |            | `1.2.3`, `latest`                  | Yes    |
-| `push tag`      | `refs/tags/mytag`             |            | `mytag`                            | Yes    |
+### Basic
+
+| 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`  | `v1.2.3`, `latest`                  |
+| `push tag`      | `refs/tags/v2.0.8-beta.67`    | `fc89efd`  | `v2.0.8-beta.67`, `latest`          |

 ```yaml
 name: ci

 on:
-  schedule:
-    - cron: '0 10 * * *' # everyday at 10am
  push:
    branches:
      - '**'
    tags:
-      - 'v*.*.*'
+      - 'v*'
  pull_request:

 jobs:
@@ -67,10 +75,134 @@ jobs:
        id: docker_meta
        uses: crazy-max/ghaction-docker-meta@v1
        with:
-          images: |
-            name/app
-            ghcr.io/name/app
-          tag-sha: true
+          images: 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-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
@@ -106,7 +238,13 @@ Following inputs can be used as `step.with` keys
 |---------------------|----------|------------------------------------|
 | `images`            | List/CSV | List of Docker images to use as base name for tags |
 | `tag-sha`           | Bool     | Add git short SHA as Docker tag (default `false`) |
-| `tag-edge`          | String   | Branch that will be tagged as edge (default `repo.default_branch`) |
+| `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-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-labels`        | String   | Separator to use for labels output (default `\n`) |

@@ -122,6 +260,81 @@ Following outputs are available
 | `tags`        | String  | Generated Docker tags |
 | `labels`      | String  | Generated Docker labels |

+## Notes
+
+### 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                | Output tags               | Output version               |
+|-------------------------|------------------------------------|-------------------|----------------------|---------------------------|------------------------------|
+| `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`                   |
+
+### 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              | 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`                   |
+
+> *First occurrence of `tag-semver` will be taken as `output.version`
+
+> **Pre-release (rc, beta, alpha) will only extend `{{version}}` as tag
+
+### Schedule tag
+
+`tag-schedule` is specially crafted input to support [Handlebars template](https://handlebarsjs.com/guide/) with
+the following expressions:
+
+| Expression              | Example                                   | Description                              |
+|-------------------------|-------------------------------------------|------------------------------------------|
+| `{{date 'format'}}`     | `{{date 'YYYYMMDD'}}` > `20200110`        | Render date by its [moment format](https://momentjs.com/docs/#/displaying/format/) 
+
+You can find more examples in the [CI workflow](.github/workflows/ci.yml).
+
+### 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

 Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)
--- a/tests/fixtures/event_tag_20200110-RC2.env
+++ b/tests/fixtures/event_tag_20200110-RC2.env
@@ -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
--- a/tests/fixtures/event_tag_release1.env
+++ b/tests/fixtures/event_tag_release1.env
--- a/tests/fixtures/event_tag_sometag.env
+++ b/tests/fixtures/event_tag_sometag.env
@@ -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
--- a/tests/fixtures/event_tag_v1.1.1.env
+++ b/tests/fixtures/event_tag_v1.1.1.env
--- a/tests/fixtures/event_tag_v2.0.8-beta.67.env
+++ b/tests/fixtures/event_tag_v2.0.8-beta.67.env
@@ -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
--- a/tests/meta.test.ts
+++ b/tests/meta.test.ts
--- a/action.yml
+++ b/action.yml
@@ -15,8 +15,30 @@ inputs:
    default: 'false'
    required: false
  tag-edge:
+    description: 'Enable edge branch tagging'
+    default: 'false'
+    required: false
+  tag-edge-branch:
    description: 'Branch that will be tagged as edge (default repo.default_branch)'
    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:
+    description: 'Template to apply to schedule tag'
+    default: 'nightly'
+    required: false
  sep-tags:
    description: 'Separator to use for tags output (default \n)'
    required: false
--- a/dist/index.js
+++ b/dist/index.js
--- a/package.json
+++ b/package.json
@@ -25,13 +25,15 @@
  "dependencies": {
    "@actions/core": "^1.2.6",
    "@actions/github": "^4.0.0",
-    "dotenv": "^8.2.0",
+    "handlebars": "^4.7.6",
+    "moment": "^2.29.1",
    "semver": "^7.3.2"
  },
  "devDependencies": {
    "@types/jest": "^26.0.0",
    "@types/node": "^14.11.2",
    "@vercel/ncc": "^0.24.1",
+    "dotenv": "^8.2.0",
    "jest": "^26.0.1",
    "jest-circus": "^26.0.1",
    "jest-runtime": "^26.0.1",
--- a/src/context.ts
+++ b/src/context.ts
@@ -3,7 +3,13 @@ import * as core from '@actions/core';
 export interface Inputs {
  images: string[];
  tagSha: boolean;
-  tagEdge: string;
+  tagEdge: boolean;
+  tagEdgeBranch: string;
+  tagSemver: string[];
+  tagMatch: string;
+  tagMatchGroup: number;
+  tagMatchLatest: boolean;
+  tagSchedule: string;
  sepTags: string;
  sepLabels: string;
  githubToken: string;
@@ -12,8 +18,14 @@ export interface Inputs {
 export function getInputs(): Inputs {
  return {
    images: getInputList('images'),
-    tagSha: /true/i.test(core.getInput('tag-sha')),
-    tagEdge: core.getInput('tag-edge'),
+    tagSha: /true/i.test(core.getInput('tag-sha') || 'false'),
+    tagEdge: /true/i.test(core.getInput('tag-edge') || 'false'),
+    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',
    sepTags: core.getInput('sep-tags') || `\n`,
    sepLabels: core.getInput('sep-labels') || `\n`,
    githubToken: core.getInput('github-token')
--- a/src/main.ts
+++ b/src/main.ts
@@ -1,6 +1,6 @@
 import {getInputs, Inputs} from './context';
 import * as github from './github';
-import {Meta} from './meta';
+import {Meta, Version} from './meta';
 import * as core from '@actions/core';
 import {Context} from '@actions/github/lib/context';
 import {ReposGetResponseData} from '@octokit/types';
@@ -27,11 +27,11 @@ async function run() {

    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.info(`${version}`);
+    core.info(version.main || '');
    core.endGroup();
-    core.setOutput('version', version);
+    core.setOutput('version', version.main || '');

    const tags: Array<string> = meta.tags();
    core.startGroup(`Docker tags`);
--- a/src/meta.ts
+++ b/src/meta.ts
@@ -1,55 +1,109 @@
+import * as handlebars from 'handlebars';
+import * as moment from 'moment';
 import * as semver from 'semver';
 import {Inputs} from './context';
-import * as core from '@actions/core';
 import {Context} from '@actions/github/lib/context';
 import {ReposGetResponseData} from '@octokit/types';

+export interface Version {
+  main: string | undefined;
+  partial: string[];
+  latest: boolean;
+}
+
 export class Meta {
  private readonly inputs: Inputs;
  private readonly context: Context;
  private readonly repo: ReposGetResponseData;
+  private readonly date: Date;

  constructor(inputs: Inputs, context: Context, repo: ReposGetResponseData) {
    this.inputs = inputs;
-    if (!this.inputs.tagEdge) {
-      this.inputs.tagEdge = repo.default_branch;
+    if (!this.inputs.tagEdgeBranch) {
+      this.inputs.tagEdgeBranch = repo.default_branch;
    }
    this.context = context;
    this.repo = repo;
+    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)) {
-      return 'nightly';
-    } else if (/^refs\/tags\//.test(this.context.ref)) {
-      const tag = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
-      const sver = semver.clean(tag);
-      return sver ? sver : tag;
-    } else if (/^refs\/heads\//.test(this.context.ref)) {
-      const branch = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
-      return this.inputs.tagEdge === branch ? 'edge' : branch;
-    } else if (/^refs\/pull\//.test(this.context.ref)) {
-      const pr = this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '');
-      return `pr-${pr}`;
+      version.main = handlebars.compile(this.inputs.tagSchedule)({
+        date: function (format) {
+          return moment(currentDate).utc().format(format);
        }
+      });
+    } else if (/^refs\/tags\//.test(this.context.ref)) {
+      version.main = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
+      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;
+        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)) {
+      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, '')}`;
+    }
+
+    version.partial = version.partial.filter((item, index) => version.partial.indexOf(item) === index);
+    return version;
  }

  public tags(): Array<string> {
+    const version: Version = this.version();
+    if (!version.main) {
+      return [];
+    }
+
    let tags: Array<string> = [];
    for (const image of this.inputs.images) {
-      if (/schedule/.test(this.context.eventName)) {
-        tags.push.apply(tags, Meta.eventSchedule(image));
-      } else if (/^refs\/tags\//.test(this.context.ref)) {
-        tags.push.apply(tags, this.eventTag(image));
-      } else if (/^refs\/heads\//.test(this.context.ref)) {
-        tags.push.apply(tags, this.eventBranch(image));
-      } 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}"`);
+      const imageLc = image.toLowerCase();
+      tags.push(`${imageLc}:${version.main}`);
+      for (const partial of version.partial) {
+        tags.push(`${imageLc}:${partial}`);
+      }
+      if (version.latest) {
+        tags.push(`${imageLc}:latest`);
      }
      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;
@@ -60,37 +114,11 @@ export class Meta {
      `org.opencontainers.image.title=${this.repo.name || ''}`,
      `org.opencontainers.image.description=${this.repo.description || ''}`,
      `org.opencontainers.image.url=${this.repo.html_url || ''}`,
-      `org.opencontainers.image.source=${this.repo.clone_url || ''}`,
-      `org.opencontainers.image.version=${this.version() || ''}`,
-      `org.opencontainers.image.created=${new Date().toISOString()}`,
+      `org.opencontainers.image.source=${this.repo.html_url || ''}`,
+      `org.opencontainers.image.version=${this.version().main || ''}`,
+      `org.opencontainers.image.created=${this.date.toISOString()}`,
      `org.opencontainers.image.revision=${this.context.sha || ''}`,
      `org.opencontainers.image.licenses=${this.repo.license?.spdx_id || ''}`
    ];
  }
-
-  private static eventSchedule(image: string): Array<string> {
-    return [`${image}:nightly`];
-  }
-
-  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 === 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}`];
-  }
 }
--- a/yarn.lock
+++ b/yarn.lock
@@ -1622,6 +1622,18 @@ growly@^1.3.0:
  resolved "https://registry.yarnpkg.com/growly/-/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081"
  integrity sha1-8QdIy+dq+WS3yWyTxrzCivEgwIE=

+handlebars@^4.7.6:
+  version "4.7.6"
+  resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.6.tgz#d4c05c1baf90e9945f77aa68a7a219aa4a7df74e"
+  integrity sha512-1f2BACcBfiwAfStCKZNrUCgqNZkGsAT7UM3kkYtXuLo0KnaVfjKOyf7PRzB6++aK9STyT1Pd2ZCPe3EGOXleXA==
+  dependencies:
+    minimist "^1.2.5"
+    neo-async "^2.6.0"
+    source-map "^0.6.1"
+    wordwrap "^1.0.0"
+  optionalDependencies:
+    uglify-js "^3.1.4"
+
 har-schema@^2.0.0:
  version "2.0.0"
  resolved "https://registry.yarnpkg.com/har-schema/-/har-schema-2.0.0.tgz#a94c2224ebcac04782a0d9035521f24735b7ec92"
@@ -2638,6 +2650,11 @@ mkdirp@1.x:
  resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e"
  integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==

+moment@^2.29.1:
+  version "2.29.1"
+  resolved "https://registry.yarnpkg.com/moment/-/moment-2.29.1.tgz#b2be769fa31940be9eeea6469c075e35006fa3d3"
+  integrity sha512-kHmoybcPV8Sqy59DwNDY3Jefr64lK/by/da0ViFcuA4DH0vQg5Q6Ze5VimxkfQNSC+Mls/Kx53s7TjP1RhFEDQ==
+
 ms@2.0.0:
  version "2.0.0"
  resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
@@ -2670,6 +2687,11 @@ natural-compare@^1.4.0:
  resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7"
  integrity sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=

+neo-async@^2.6.0:
+  version "2.6.2"
+  resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f"
+  integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==
+
 nice-try@^1.0.4:
  version "1.0.5"
  resolved "https://registry.yarnpkg.com/nice-try/-/nice-try-1.0.5.tgz#a3378a7696ce7d223e88fc9b764bd7ef1089e366"
@@ -3580,6 +3602,11 @@ typescript@^4.0.3:
  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.0.3.tgz#153bbd468ef07725c1df9c77e8b453f8d36abba5"
  integrity sha512-tEu6DGxGgRJPb/mVPIZ48e69xCn2yRmCgYmDugAVwmJ6o+0u1RI18eO7E7WBTLYLaEVVOhwQmcdhQHweux/WPg==

+uglify-js@^3.1.4:
+  version "3.11.3"
+  resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.11.3.tgz#b2f8c87826344f091ba48c417c499d6cba5d5786"
+  integrity sha512-wDRziHG94mNj2n3R864CvYw/+pc9y/RNImiTyrrf8BzgWn75JgFSwYvXrtZQMnMnOp/4UTrf3iCSQxSStPiByA==
+
 union-value@^1.0.0:
  version "1.0.1"
  resolved "https://registry.yarnpkg.com/union-value/-/union-value-1.0.1.tgz#0b6fe7b835aecda61c6ea4d4f02c14221e109847"
@@ -3732,6 +3759,11 @@ word-wrap@~1.2.3:
  resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"
  integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==

+wordwrap@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb"
+  integrity sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=
+
 wrap-ansi@^6.2.0:
  version "6.2.0"
  resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53"
Author	SHA1	Message	Date
CrazyMax	0dca12c226	Update CHANGELOG	2020-11-20 20:26:04 +01:00
CrazyMax	6f270f37d4	Add test	2020-11-20 16:30:57 +01:00
CrazyMax	2860e42b1f	Lowercase only on image name (#16 )	2020-11-20 16:19:08 +01:00
CrazyMax	6a86fe1739	Tags to lowercase (#16 )	2020-11-20 15:54:36 +01:00
CrazyMax	86dc87790d	Update README	2020-11-18 17:56:39 +01:00
CrazyMax	b3281c85e6	Update CHANGELOG	2020-11-18 16:57:42 +01:00
CrazyMax	9ba75ef142	Update README	2020-11-18 01:18:53 +01:00
CrazyMax	a017e545d7	Remove duplicated tags	2020-11-18 01:10:05 +01:00
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
CrazyMax	8ec02f11ef	Update CHANGELOG	2020-10-25 15:42:23 +01:00
CrazyMax	82966b7661	Update test workflow	2020-10-25 15:36:42 +01:00
CrazyMax	cb039680df	Allow to disable edge branch tagging (#2 ) Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>	2020-10-25 14:32:14 +00:00
CrazyMax	a0b5755726	Update README	2020-10-25 15:17:44 +01:00
CrazyMax	3b38d53d94	Allow to templatize schedule tag (#1 ) Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>	2020-10-25 14:13:43 +00:00
CrazyMax	88d487154b	Fix deps	2020-10-25 03:34:48 +01:00