docker-metadata-action/src/meta.ts

import * as handlebars from 'handlebars';
import * as moment from 'moment';
import {Inputs} from './context';
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;
  private readonly repo: ReposGetResponseData;
  private readonly date: Date;

  constructor(inputs: Inputs, context: Context, repo: ReposGetResponseData) {
    this.inputs = inputs;
    if (!this.inputs.tagEdgeBranch) {
      this.inputs.tagEdgeBranch = repo.default_branch;
    }
    this.context = context;
    this.repo = repo;
    this.date = new Date();
  }

  public version(): Version {
    const currentDate = this.date;
    const version: Version = {
      version: undefined,
      latest: false
    };

    if (/schedule/.test(this.context.eventName)) {
      version.version = handlebars.compile(this.inputs.tagSchedule)({
        date: function (format) {
          return moment(currentDate).utc().format(format);
        }
      });
    } 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);
        if (tagMatch) {
          version.version = tagMatch[0];
          version.latest = this.inputs.tagMatchLatest;
        }
      }
    } else if (/^refs\/heads\//.test(this.context.ref)) {
      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)) {
      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) {
      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)}`);
      }
    }
    return tags;
  }

  public labels(): Array<string> {
    return [
      `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().version || ''}`,
      `org.opencontainers.image.created=${this.date.toISOString()}`,
      `org.opencontainers.image.revision=${this.context.sha || ''}`,
      `org.opencontainers.image.licenses=${this.repo.license?.spdx_id || ''}`
    ];
  }
}