Coerces Git tag to semver (#3)

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

src/context.ts

@@ -5,6 +5,7 @@ export interface Inputs {
   tagSha: boolean;
   tagEdge: boolean;
   tagEdgeBranch: string;
+  tagCoerceTag: string;
   tagSchedule: string;
   sepTags: string;
   sepLabels: string;
@@ -17,6 +18,7 @@ export function getInputs(): Inputs {
     tagSha: /true/i.test(core.getInput('tag-sha') || 'false'),
     tagEdge: /true/i.test(core.getInput('tag-edge') || 'false'),
     tagEdgeBranch: core.getInput('tag-edge-branch'),
+    tagCoerceTag: core.getInput('tag-coerce-tag'),
     tagSchedule: core.getInput('tag-schedule') || 'nightly',
     sepTags: core.getInput('sep-tags') || `\n`,
     sepLabels: core.getInput('sep-labels') || `\n`,

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.version || '');
     core.endGroup();
-    core.setOutput('version', version || '');
+    core.setOutput('version', version.version || '');
 
     const tags: Array<string> = meta.tags();
     core.startGroup(`Docker tags`);

src/meta.ts

@@ -2,10 +2,14 @@ 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 {
+  version: string | undefined;
+  latest: boolean;
+}
+
 export class Meta {
   private readonly inputs: Inputs;
   private readonly context: Context;
@@ -22,35 +26,62 @@ export class Meta {
     this.date = new Date();
   }
 
-  public version(): string | undefined {
+  public version(): Version {
+    const currentDate = this.date;
+    const version: Version = {
+      version: undefined,
+      latest: false
+    };
+
     if (/schedule/.test(this.context.eventName)) {
-      return handlebars.compile(this.inputs.tagSchedule)(this.scheduleTplContext());
+      version.version = handlebars.compile(this.inputs.tagSchedule)({
+        date: function (format) {
+          return moment(currentDate).utc().format(format);
+        }
+      });
     } 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;
+      if (this.inputs.tagCoerceTag) {
+        const coerce = semver.coerce(tag);
+        if (coerce) {
+          version.version = handlebars.compile(this.inputs.tagCoerceTag)(coerce);
+          version.latest = true;
+        } else if (sver) {
+          version.version = sver;
+          version.latest = true;
+        } else {
+          version.version = tag;
+        }
+      } else if (sver) {
+        version.version = sver;
+        version.latest = true;
+      } else {
+        version.version = tag;
+      }
     } else if (/^refs\/heads\//.test(this.context.ref)) {
-      const branch = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
-      return this.inputs.tagEdge && this.inputs.tagEdgeBranch === branch ? 'edge' : branch;
+      version.version = this.context.ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
+      if (this.inputs.tagEdge && this.inputs.tagEdgeBranch === version.version) {
+        version.version = 'edge';
+      }
     } else if (/^refs\/pull\//.test(this.context.ref)) {
-      const pr = this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '');
-      return `pr-${pr}`;
+      version.version = `pr-${this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '')}`;
     }
+
+    return version;
   }
 
   public tags(): Array<string> {
+    const version: Version = this.version();
+    if (!version.version) {
+      return [];
+    }
+
     let tags: Array<string> = [];
     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)) {
-        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}"`);
+      tags.push(`${image}:${version.version}`);
+      if (version.latest) {
+        tags.push(`${image}:latest`);
       }
       if (this.context.sha && this.inputs.tagSha) {
         tags.push(`${image}:sha-${this.context.sha.substr(0, 7)}`);
@@ -65,46 +96,10 @@ export class Meta {
       `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.version=${this.version().version || ''}`,
       `org.opencontainers.image.created=${this.date.toISOString()}`,
       `org.opencontainers.image.revision=${this.context.sha || ''}`,
       `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);
-      }
-    };
-  }
 }