Update CHANGELOG

Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>

.github/workflows/ci.yml

@@ -82,10 +82,18 @@ jobs:
 
   tag-semver:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        tag-latest:
+          - 'true'
+          - 'false'
     steps:
-      - name: Checkout
+      -
+        name: Checkout
         uses: actions/checkout@v2
-      - name: Docker meta
+      -
+        name: Docker meta
         uses: ./
         with:
           images: |
@@ -95,6 +103,7 @@ jobs:
             {{raw}}
             {{version}}
             {{major}}.{{minor}}.{{patch}}
+          tag-latest: ${{ matrix.tag-latest }}
 
   docker-push:
     runs-on: ubuntu-latest
@@ -114,7 +123,10 @@ jobs:
         with:
           images: ${{ env.DOCKER_IMAGE }}
           tag-sha: true
-          tag-match: '\d{1,3}.\d{1,3}.\d{1,3}'
+          tag-semver: |
+            v{{version}}
+            v{{major}}.{{minor}}
+            v{{major}}
       -
         name: Set up QEMU
         uses: docker/setup-qemu-action@v1

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.9.1 (2020/12/07)
+
+* Replace forbidden chars derived from branch name (#31)
+* Bump semver from 7.3.2 to 7.3.4 (#26)
+
+## 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)

README.md

@@ -26,8 +26,8 @@ ___
   * [outputs](#outputs)
 * [Notes](#notes)
   * [Latest tag](#latest-tag)
-  * [`tag-match` examples](#tag-match-examples)
   * [Handle semver tag](#handle-semver-tag)
+  * [`tag-match` examples](#tag-match-examples)
   * [Schedule tag](#schedule-tag)
   * [Overwrite labels](#overwrite-labels)
 * [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
@@ -168,11 +168,11 @@ jobs:
 | 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`                   |
+| `pull_request`  | `refs/pull/2/merge`           | `a123b57`  | `sha-a123b57`, `pr-2`                   |
-| `push`          | `refs/heads/master`           | `cf20257`  | `sha-45f132a`, `master`                 |
+| `push`          | `refs/heads/master`           | `cf20257`  | `sha-cf20257`, `master`                 |
-| `push`          | `refs/heads/my/branch`        | `a5df687`  | `sha-45f132a`, `my-branch`              |
+| `push`          | `refs/heads/my/branch`        | `a5df687`  | `sha-a5df687`, `my-branch`              |
-| `push tag`      | `refs/tags/v1.2.3`            | `ad132f5`  | `sha-45f132a`, `1.2.3`, `1.2`, `latest` |
+| `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-45f132a`, `2.0.8-beta.67`          |
+| `push tag`      | `refs/tags/v2.0.8-beta.67`    | `fc89efd`  | `sha-fc89efd`, `2.0.8-beta.67`          |
 
 ```yaml
 name: ci
@@ -200,6 +200,7 @@ jobs:
         uses: crazy-max/ghaction-docker-meta@v1
         with:
           images: name/app
+          tag-sha: true
           tag-semver: |
             {{version}}
             {{major}}.{{minor}}
@@ -240,16 +241,20 @@ Following inputs can be used as `step.with` keys
 | `tag-sha`           | Bool     | Add git short SHA as Docker tag (default `false`) |
 | `tag-edge`          | Bool     | Enable edge branch tagging (default `false`) |
 | `tag-edge-branch`   | String   | Branch that will be tagged as edge (default `repo.default_branch`) |
-| `tag-semver`        | List     | Handle Git tag as semver [template](#handle-semver-tag) if possible |
+| `tag-semver`        | List/CSV | 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-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-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-labels`        | String   | Separator to use for labels output (default `\n`) |
 
 > List/CSV type can be a newline or comma delimited string
 
+> `tag-semver` and `tag-match` are mutually exclusive
+
 ### outputs
 
 Following outputs are available
@@ -266,18 +271,8 @@ Following outputs are available
 
 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
+generated only if `tag-semver` is a valid [semver](https://semver.org/) or if Git tag matches a regular expression
-`tag-semver` is valid [semver](https://semver.org/).
+with the [`tag-match` input](#tag-match-examples). Can be disabled if `tag-latest` is `false`.
-
-### `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
 
@@ -293,14 +288,25 @@ If Git tag is a valid [semver](https://semver.org/) you can handle it to output
 | `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`   | `{{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
+> **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.
+
+### `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`                   |
 
 ### Schedule tag
 

__tests__/fixtures/event_push_invalidchars.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_89a016e8-e5b7-4039-a67e-c8da08f87a0c
+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_89a016e8-e5b7-4039-a67e-c8da08f87a0c
+GITHUB_REF="refs/heads/my/feature#1245"
+GITHUB_REPOSITORY=crazy-max/test-docker-action
+GITHUB_REPOSITORY_OWNER=crazy-max
+GITHUB_RETENTION_DAYS=90
+GITHUB_RUN_ID=325957516
+GITHUB_RUN_NUMBER=1
+GITHUB_SERVER_URL=https://github.com
+GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
+GITHUB_WORKFLOW=event
+GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action

__tests__/meta.test.ts

@@ -44,7 +44,7 @@ const tagsLabelsTest = async (envFile: string, inputs: Inputs, exVersion: Versio
   const repo = await github.repo(process.env.GITHUB_TOKEN || '');
   const meta = new Meta({...getInputs(), ...inputs}, context, repo);
 
-  const version = meta.version();
+  const version = meta.version;
   console.log('version', version);
   expect(version).toEqual(exVersion);
 
@@ -376,6 +376,35 @@ describe('push', () => {
         "org.opencontainers.image.licenses=MIT"
       ]
     ],
+    [
+      'event_push_invalidchars.env',
+      {
+        images: ['org/app', 'ghcr.io/user/app'],
+        tagSha: true,
+        tagEdge: true,
+      } as Inputs,
+      {
+        main: 'my-feature-1245',
+        partial: [],
+        latest: false
+      } as Version,
+      [
+        'org/app:my-feature-1245',
+        'org/app:sha-90dd603',
+        'ghcr.io/user/app:my-feature-1245',
+        'ghcr.io/user/app:sha-90dd603'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=my-feature-1245",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
   ])('given %p event ', tagsLabelsTest);
 });
 
@@ -437,7 +466,7 @@ describe('push tag', () => {
       {
         images: ['user/app'],
         tagMatch: `\\d{8}`,
-        tagMatchLatest: false,
+        tagLatest: false,
       } as Inputs,
       {
         main: '20200110',
@@ -464,7 +493,7 @@ describe('push tag', () => {
         images: ['user/app'],
         tagMatch: `(.*)-RC`,
         tagMatchGroup: 1,
-        tagMatchLatest: false,
+        tagLatest: false,
       } as Inputs,
       {
         main: '20200110',
@@ -715,7 +744,7 @@ describe('push tag', () => {
       'event_tag_v2.0.8-beta.67.env',
       {
         images: ['org/app', 'ghcr.io/user/app'],
-        tagSemver: ['{{version}}', '{{major}}.{{minor}}', '{{major}}'],
+        tagSemver: ['{{major}}.{{minor}}', '{{major}}'],
       } as Inputs,
       {
         main: '2.0.8-beta.67',
@@ -737,6 +766,32 @@ describe('push tag', () => {
         "org.opencontainers.image.licenses=MIT"
       ]
     ],
+    [
+      'event_tag_sometag.env',
+      {
+        images: ['ghcr.io/user/app'],
+        tagSemver: ['{{version}}', '{{major}}.{{minor}}', '{{major}}'],
+        tagLatest: false,
+      } as Inputs,
+      {
+        main: 'sometag',
+        partial: [],
+        latest: false
+      } as Version,
+      [
+        'ghcr.io/user/app:sometag'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=sometag",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
   ])('given %p event ', tagsLabelsTest);
 });
 
@@ -906,7 +961,7 @@ describe('latest', () => {
       'event_tag_v1.1.1.env',
       {
         images: ['org/app', 'ghcr.io/user/app'],
-        tagMatchLatest: false,
+        tagLatest: false,
       } as Inputs,
       {
         main: 'v1.1.1',
@@ -932,7 +987,7 @@ describe('latest', () => {
       'event_tag_v1.1.1.env',
       {
         images: ['org/app', 'ghcr.io/MyUSER/MyApp'],
-        tagMatchLatest: false,
+        tagLatest: false,
       } as Inputs,
       {
         main: 'v1.1.1',
@@ -1203,3 +1258,193 @@ describe('release', () => {
     ],
   ])('given %p event ', tagsLabelsTest);
 });
+
+describe('custom', () => {
+  // prettier-ignore
+  test.each([
+    [
+      'event_push.env',
+      {
+        images: ['user/app'],
+        tagCustom: ['my', 'custom', 'tags']
+      } as Inputs,
+      {
+        main: 'dev',
+        partial: ['my', 'custom', 'tags'],
+        latest: false
+      } as Version,
+      [
+        'user/app:dev',
+        'user/app:my',
+        'user/app:custom',
+        'user/app:tags'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=dev",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
+    [
+      'event_push.env',
+      {
+        images: ['user/app'],
+        tagCustom: ['my']
+      } as Inputs,
+      {
+        main: 'dev',
+        partial: ['my'],
+        latest: false
+      } as Version,
+      [
+        'user/app:dev',
+        'user/app:my'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=dev",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
+    [
+      'event_tag_release1.env',
+      {
+        images: ['user/app'],
+        tagCustom: ['my', 'custom', 'tags']
+      } as Inputs,
+      {
+        main: 'release1',
+        partial: ['my', 'custom', 'tags'],
+        latest: true
+      } as Version,
+      [
+        'user/app:release1',
+        'user/app:my',
+        'user/app:custom',
+        'user/app:tags',
+        'user/app:latest'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=release1",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
+    [
+      'event_tag_20200110-RC2.env',
+      {
+        images: ['user/app'],
+        tagMatch: `\\d{8}`,
+        tagLatest: false,
+        tagCustom: ['my', 'custom', 'tags']
+      } as Inputs,
+      {
+        main: '20200110',
+        partial: ['my', 'custom', 'tags'],
+        latest: false
+      } as Version,
+      [
+        'user/app:20200110',
+        'user/app:my',
+        'user/app:custom',
+        'user/app:tags'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=20200110",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
+    [
+      'event_tag_v1.1.1.env',
+      {
+        images: ['org/app', 'ghcr.io/user/app'],
+        tagSemver: ['{{version}}', '{{major}}.{{minor}}', '{{major}}'],
+        tagCustom: ['my', 'custom', 'tags']
+      } as Inputs,
+      {
+        main: '1.1.1',
+        partial: ['1.1', '1', 'my', 'custom', 'tags'],
+        latest: true
+      } as Version,
+      [
+        'org/app:1.1.1',
+        'org/app:1.1',
+        'org/app:1',
+        'org/app:my',
+        'org/app:custom',
+        'org/app:tags',
+        'org/app:latest',
+        'ghcr.io/user/app:1.1.1',
+        'ghcr.io/user/app:1.1',
+        'ghcr.io/user/app:1',
+        'ghcr.io/user/app:my',
+        'ghcr.io/user/app:custom',
+        'ghcr.io/user/app:tags',
+        'ghcr.io/user/app:latest'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=1.1.1",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
+    [
+      'event_tag_v1.1.1.env',
+      {
+        images: ['org/app', 'ghcr.io/user/app'],
+        tagSemver: ['{{version}}', '{{major}}.{{minor}}.{{patch}}'],
+        tagCustom: ['my', 'custom', 'tags'],
+        tagCustomOnly: true,
+      } as Inputs,
+      {
+        main: 'my',
+        partial: ['custom', 'tags'],
+        latest: false
+      } as Version,
+      [
+        'org/app:my',
+        'org/app:custom',
+        'org/app:tags',
+        'ghcr.io/user/app:my',
+        'ghcr.io/user/app:custom',
+        'ghcr.io/user/app:tags'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=my",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
+  ])('given %p event ', tagsLabelsTest);
+});

action.yml

@@ -31,14 +31,25 @@ inputs:
     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:
-    description: 'Set latest Docker tag if tag-match matches or on Git tag event'
+    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
   tag-schedule:
     description: 'Template to apply to schedule tag'
     default: 'nightly'
     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:
     description: 'Separator to use for tags output (default \n)'
     required: false

package.json

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

src/context.ts

@@ -8,8 +8,10 @@ export interface Inputs {
   tagSemver: string[];
   tagMatch: string;
   tagMatchGroup: number;
-  tagMatchLatest: boolean;
+  tagLatest: boolean;
   tagSchedule: string;
+  tagCustom: string[];
+  tagCustomOnly: boolean;
   sepTags: string;
   sepLabels: string;
   githubToken: string;
@@ -24,8 +26,10 @@ export function getInputs(): Inputs {
     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'),
+    tagLatest: /true/i.test(core.getInput('tag-latest') || core.getInput('tag-match-latest') || 'true'),
     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`,
     sepLabels: core.getInput('sep-labels') || `\n`,
     githubToken: core.getInput('github-token')

src/main.ts

@@ -27,7 +27,7 @@ async function run() {
 
     const meta: Meta = new Meta(inputs, context, repo);
 
-    const version: Version = meta.version();
+    const version: Version = meta.version;
     core.startGroup(`Docker image version`);
     core.info(version.main || '');
     core.endGroup();
@@ -47,7 +47,7 @@ async function run() {
       core.info(label);
     }
     core.endGroup();
-    core.setOutput('labels', labels.join(inputs.sepTags));
+    core.setOutput('labels', labels.join(inputs.sepLabels));
   } catch (error) {
     core.setFailed(error.message);
   }

src/meta.ts

@@ -2,6 +2,7 @@ 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';
 
@@ -12,6 +13,8 @@ export interface Version {
 }
 
 export class Meta {
+  public readonly version: Version;
+
   private readonly inputs: Inputs;
   private readonly context: Context;
   private readonly repo: ReposGetResponseData;
@@ -25,11 +28,12 @@ export class Meta {
     this.context = context;
     this.repo = repo;
     this.date = new Date();
+    this.version = this.getVersion();
   }
 
-  public version(): Version {
+  private getVersion(): Version {
     const currentDate = this.date;
-    const version: Version = {
+    let version: Version = {
       main: undefined,
       partial: [],
       latest: false
@@ -43,13 +47,18 @@ export class Meta {
       });
     } 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)) {
+        core.warning(`${version.main} is not a valid semver. More info: https://semver.org/`);
+      }
       if (this.inputs.tagSemver.length > 0 && semver.valid(version.main)) {
         const sver = semver.parse(version.main, {
           includePrerelease: true
         });
-        version.latest = !semver.prerelease(version.main);
+        if (semver.prerelease(version.main)) {
-        version.main = handlebars.compile(this.inputs.tagSemver[0])(sver);
+          version.main = handlebars.compile('{{version}}')(sver);
-        if (version.latest) {
+        } else {
+          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) {
@@ -68,13 +77,13 @@ export class Meta {
         }
         if (tagMatch) {
           version.main = tagMatch[this.inputs.tagMatchGroup];
-          version.latest = this.inputs.tagMatchLatest;
+          version.latest = this.inputs.tagLatest;
         }
       } else {
-        version.latest = this.inputs.tagMatchLatest;
+        version.latest = this.inputs.tagLatest;
       }
     } else if (/^refs\/heads\//.test(this.context.ref)) {
-      version.main = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
+      version.main = this.context.ref.replace(/^refs\/heads\//g, '').replace(/[^a-zA-Z0-9._-]+/g, '-');
       if (this.inputs.tagEdge && this.inputs.tagEdgeBranch === version.main) {
         version.main = 'edge';
       }
@@ -82,24 +91,35 @@ export class Meta {
       version.main = `pr-${this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '')}`;
     }
 
+    if (this.inputs.tagCustom.length > 0) {
+      if (this.inputs.tagCustomOnly) {
+        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;
   }
 
   public tags(): Array<string> {
-    const version: Version = this.version();
+    if (!this.version.main) {
-    if (!version.main) {
       return [];
     }
 
     let tags: Array<string> = [];
     for (const image of this.inputs.images) {
       const imageLc = image.toLowerCase();
-      tags.push(`${imageLc}:${version.main}`);
+      tags.push(`${imageLc}:${this.version.main}`);
-      for (const partial of version.partial) {
+      for (const partial of this.version.partial) {
         tags.push(`${imageLc}:${partial}`);
       }
-      if (version.latest) {
+      if (this.version.latest) {
         tags.push(`${imageLc}:latest`);
       }
       if (this.context.sha && this.inputs.tagSha) {
@@ -115,7 +135,7 @@ export class Meta {
       `org.opencontainers.image.description=${this.repo.description || ''}`,
       `org.opencontainers.image.url=${this.repo.html_url || ''}`,
       `org.opencontainers.image.source=${this.repo.html_url || ''}`,
-      `org.opencontainers.image.version=${this.version().main || ''}`,
+      `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 || ''}`

yarn.lock

@@ -2545,6 +2545,13 @@ lodash@^4.17.19:
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.20.tgz#b44a9b6297bcb698f1c51a3545a2b3b368d59c52"
   integrity sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==
 
+lru-cache@^6.0.0:
+  version "6.0.0"
+  resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94"
+  integrity sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==
+  dependencies:
+    yallist "^4.0.0"
+
 make-dir@^3.0.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-3.1.0.tgz#415e967046b3a7f1d185277d84aa58203726a13f"
@@ -3163,10 +3170,12 @@ saxes@^5.0.0:
   resolved "https://registry.yarnpkg.com/semver/-/semver-5.7.1.tgz#a954f931aeba508d307bbf069eff0c01c96116f7"
   integrity sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==
 
-semver@7.x, semver@^7.3.2:
+semver@7.x, semver@^7.3.2, semver@^7.3.4:
-  version "7.3.2"
+  version "7.3.4"
-  resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.2.tgz#604962b052b81ed0786aae84389ffba70ffd3938"
+  resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.4.tgz#27aaa7d2e4ca76452f98d3add093a72c943edc97"
-  integrity sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==
+  integrity sha512-tCfb2WLjqFAtXn4KEdxIhalnRtoKFN7nAwj0B3ZXCbQloV2tq5eDbcTmT68JJD3nRJq24/XgxtQKFIpQdtvmVw==
+  dependencies:
+    lru-cache "^6.0.0"
 
 semver@^6.0.0, semver@^6.3.0:
   version "6.3.0"
@@ -3808,6 +3817,11 @@ y18n@^4.0.0:
   resolved "https://registry.yarnpkg.com/y18n/-/y18n-4.0.0.tgz#95ef94f85ecc81d007c264e190a120f0a3c8566b"
   integrity sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==
 
+yallist@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
+  integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
+
 yargs-parser@20.x:
   version "20.2.3"
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.3.tgz#92419ba867b858c868acf8bae9bf74af0dd0ce26"