Update CHANGELOG

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

.github/workflows/ci.yml

@@ -53,15 +53,18 @@ jobs:
           tag-sha: true
           tag-schedule: ${{ matrix.tag-schedule }}
 
-  coerce:
+  tag-match:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        tag-coerce-tag:
-          - "{{raw}}"
-          - "{{major}}.{{minor}}"
-          - "{{patch}}"
+        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
@@ -73,8 +76,9 @@ jobs:
           images: |
             ${{ env.DOCKER_IMAGE }}
             ghcr.io/name/app
-          tag-coerce-tag: ${{ matrix.tag-coerce-tag }}
           tag-sha: true
+          tag-match: ${{ matrix.tag-match }}
+          tag-match-group: ${{ matrix.tag-match-group }}
 
   docker-push:
     runs-on: ubuntu-latest
@@ -92,9 +96,9 @@ jobs:
         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

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 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

README.md

@@ -23,8 +23,10 @@ ___
   * [inputs](#inputs)
   * [outputs](#outputs)
 * [Notes](#notes)
+  * [Latest tag](#latest-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)
 * [How can I help?](#how-can-i-help)
 * [License](#license)
@@ -41,10 +43,9 @@ ___
 |-----------------|-------------------------------|------------|-------------------------------------|
 | `schedule`      | `refs/heads/master`           | `45f132a`  | `sha-45f132a`, `nightly`            |
 | `pull_request`  | `refs/pull/2/merge`           | `a123b57`  | `sha-a123b57`, `pr-2`               |
-| `push`          | `refs/heads/<default_branch>` | `676cae2`  | `sha-676cae2`, `edge`               |
-| `push`          | `refs/heads/dev`              | `cf20257`  | `sha-cf20257`, `dev`                |
+| `push`          | `refs/heads/master`           | `cf20257`  | `sha-cf20257`, `master`             |
 | `push`          | `refs/heads/my/branch`        | `a5df687`  | `sha-a5df687`, `my-branch`          |
-| `push tag`      | `refs/tags/v1.2.3`            | `bf4565b`  | `sha-bf4565b`, `1.2.3`, `latest`    |
+| `push tag`      | `refs/tags/v1.2.3`            | `bf4565b`  | `sha-bf4565b`, `v1.2.3`, `latest`   |
 | `push tag`      | `refs/tags/mytag`             | `afb7833`  | `sha-afb7833`, `mytag`              |
 
 ## Usage
@@ -75,8 +76,6 @@ jobs:
         uses: crazy-max/ghaction-docker-meta@v1
         with:
           images: name/app
-          tag-sha: true
-          tag-match: \\d{1,3}.\\d{1,3}.\\d{1,3}
       -
         name: Set up QEMU
         uses: docker/setup-qemu-action@v1
@@ -114,7 +113,8 @@ 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-match`         | String   | RegExp to match against a Git tag and use match group as Docker tag |
+| `tag-match`         | String   | RegExp to match against a Git tag and use first match as Docker tag |
+| `tag-match-group`   | Number   | Group to get if `tag-match` matches (default `0`) |
 | `tag-match-latest`  | Bool     | Set `latest` Docker tag if `tag-match` matches (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`) |
@@ -134,15 +134,21 @@ Following outputs are available
 
 ## Notes
 
+### Latest tag
+
+Latest Docker tag will be generated by default on `push tag` event. So if for example you push the `v1.2.3` Git tag,
+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).
+
 ### `tag-match` examples
 
-| Git tag                 | `tag-match`                    | Docker tag
-|-------------------------|--------------------------------|-------------------|
-| `v1.2.3`                | `\\d{1,3}.\\d{1,3}.\\d{1,3}`   | `1.2.3`           |
-| `v2.0.8-beta.67`        | `\\d{1,3}.\\d{1,3}.\\d{1,3}.*` | `2.0.8-beta.67`   |
-| `v2.0.8-beta.67`        | `\\d{1,3}.\\d{1,3}`            | `2.0`             |
-| `release1`              | `\\d{1,3}.\\d{1,3}`            | `release1`        |
-| `20200110-RC2`          | `\\d+`                         | `20200110`        |
+| Git tag                 | `tag-match`                        | `tag-match-group` | Docker tag
+|-------------------------|------------------------------------|-------------------|------------------|
+| `v1.2.3`                | `\d{1,3}.\d{1,3}.\d{1,3}`          | `0`               | `1.2.3`          |
+| `v2.0.8-beta.67`        | `v(.*)`                            | `1`               | `2.0.8-beta.67`  |
+| `v2.0.8-beta.67`        | `v(\d.\d)`                         | `1`               | `2.0`            |
+| `release1`              | `\d{1,3}.\d{1,3}`                  | `0`               | `release1`       |
+| `20200110-RC2`          | `\d+`                              | `0`               | `20200110`       |
 
 ### Schedule tag
 
@@ -155,6 +161,28 @@ the following expressions:
 
 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)

__tests__/meta.test.ts

@@ -377,10 +377,11 @@ describe('push tag', () => {
       } as Inputs,
       {
         version: 'release1',
-        latest: false
+        latest: true
       } as Version,
       [
-        'user/app:release1'
+        'user/app:release1',
+        'user/app:latest'
       ],
       [
         "org.opencontainers.image.title=Hello-World",
@@ -400,10 +401,11 @@ describe('push tag', () => {
       } as Inputs,
       {
         version: '20200110-RC2',
-        latest: false
+        latest: true
       } as Version,
       [
-        'user/app:20200110-RC2'
+        'user/app:20200110-RC2',
+        'user/app:latest'
       ],
       [
         "org.opencontainers.image.title=Hello-World",
@@ -441,6 +443,32 @@ describe('push tag', () => {
         "org.opencontainers.image.licenses=MIT"
       ]
     ],
+    [
+      'event_tag_20200110-RC2.env',
+      {
+        images: ['user/app'],
+        tagMatch: `(.*)-RC`,
+        tagMatchGroup: 1,
+        tagMatchLatest: false,
+      } as Inputs,
+      {
+        version: '20200110',
+        latest: false
+      } as Version,
+      [
+        'user/app:20200110'
+      ],
+      [
+        "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.git",
+        "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',
       {
@@ -660,11 +688,13 @@ describe('latest', () => {
       } as Inputs,
       {
         version: 'v1.1.1',
-        latest: false
+        latest: true
       } as Version,
       [
         'org/app:v1.1.1',
+        'org/app:latest',
         'ghcr.io/user/app:v1.1.1',
+        'ghcr.io/user/app:latest',
       ],
       [
         "org.opencontainers.image.title=Hello-World",
@@ -925,10 +955,11 @@ describe('release', () => {
       } as Inputs,
       {
         version: 'v1.1.1',
-        latest: false
+        latest: true
       } as Version,
       [
         'user/app:v1.1.1',
+        'user/app:latest',
       ],
       [
         "org.opencontainers.image.title=Hello-World",

action.yml

@@ -24,6 +24,10 @@ inputs:
   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'
     default: 'true'

dist/index.js

@@ -26,6 +26,7 @@ function getInputs() {
         tagEdge: /true/i.test(core.getInput('tag-edge') || 'false'),
         tagEdgeBranch: core.getInput('tag-edge-branch'),
         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`,
@@ -194,12 +195,22 @@ class Meta {
         else if (/^refs\/tags\//.test(this.context.ref)) {
             version.version = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
             if (this.inputs.tagMatch) {
-                const tagMatch = version.version.match(this.inputs.tagMatch);
+                let tagMatch;
+                const isRegEx = this.inputs.tagMatch.match(/^\/(.+)\/(.*)$/);
+                if (isRegEx) {
+                    tagMatch = version.version.match(new RegExp(isRegEx[1], isRegEx[2]));
+                }
+                else {
+                    tagMatch = version.version.match(this.inputs.tagMatch);
+                }
                 if (tagMatch) {
-                    version.version = tagMatch[0];
+                    version.version = tagMatch[this.inputs.tagMatchGroup];
                     version.latest = this.inputs.tagMatchLatest;
                 }
             }
+            else {
+                version.latest = true;
+            }
         }
         else if (/^refs\/heads\//.test(this.context.ref)) {
             version.version = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');

src/context.ts

@@ -6,6 +6,7 @@ export interface Inputs {
   tagEdge: boolean;
   tagEdgeBranch: string;
   tagMatch: string;
+  tagMatchGroup: number;
   tagMatchLatest: boolean;
   tagSchedule: string;
   sepTags: string;
@@ -20,6 +21,7 @@ export function getInputs(): Inputs {
     tagEdge: /true/i.test(core.getInput('tag-edge') || 'false'),
     tagEdgeBranch: core.getInput('tag-edge-branch'),
     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`,

src/meta.ts

@@ -41,11 +41,19 @@ export class Meta {
     } else if (/^refs\/tags\//.test(this.context.ref)) {
       version.version = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
       if (this.inputs.tagMatch) {
-        const tagMatch = version.version.match(this.inputs.tagMatch);
+        let tagMatch;
+        const isRegEx = this.inputs.tagMatch.match(/^\/(.+)\/(.*)$/);
+        if (isRegEx) {
+          tagMatch = version.version.match(new RegExp(isRegEx[1], isRegEx[2]));
+        } else {
+          tagMatch = version.version.match(this.inputs.tagMatch);
+        }
         if (tagMatch) {
-          version.version = tagMatch[0];
+          version.version = tagMatch[this.inputs.tagMatchGroup];
           version.latest = this.inputs.tagMatchLatest;
         }
+      } else {
+        version.latest = true;
       }
     } else if (/^refs\/heads\//.test(this.context.ref)) {
       version.version = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');