feat: add artifacts and metadata outputs (#327)

Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-02-27 20:01:51 +01:00 · 2022-02-27 20:01:51 +01:00 · c127c9be61
parent affd781166
commit c127c9be61
9 changed files with 8176 additions and 132 deletions
--- a/README.md
+++ b/README.md
@ -22,6 +22,7 @@ ___
  * [Install Only](#install-only)
 * [Customizing](#customizing)
  * [inputs](#inputs)
+  * [outputs](#outputs)
  * [environment variables](#environment-variables)
 * [Limitation](#limitation)
 * [Development](#development)
@ -50,8 +51,6 @@ jobs:
      -
        name: Set up Go
        uses: actions/setup-go@v2
-        with:
-          go-version: 1.15
      -
        name: Run GoReleaser
        uses: goreleaser/goreleaser-action@v2
@ -179,6 +178,15 @@ Following inputs can be used as `step.with` keys

 > **¹** Can be a fixed version like `v0.117.0` or a max satisfying semver one like `~> 0.132`. In this case this will return `v0.132.1`.

+### outputs
+
+Following outputs are available
+
+| Name              | Type    | Description                           |
+|-------------------|---------|---------------------------------------|
+| `artifacts`       | JSON    | Build result artifacts |
+| `metadata`        | JSON    | Build result metadata |
+
 ### environment variables

 Following environment variables can be used as `step.env` keys
--- a/tests/context.test.ts
+++ b/tests/context.test.ts
@ -0,0 +1,31 @@
+import * as os from 'os';
+import * as context from '../src/context';
+
+describe('setOutput', () => {
+  beforeEach(() => {
+    process.stdout.write = jest.fn();
+  });
+
+  it('setOutput produces the correct command', () => {
+    context.setOutput('some output', 'some value');
+    assertWriteCalls([`::set-output name=some output::some value${os.EOL}`]);
+  });
+
+  it('setOutput handles bools', () => {
+    context.setOutput('some output', false);
+    assertWriteCalls([`::set-output name=some output::false${os.EOL}`]);
+  });
+
+  it('setOutput handles numbers', () => {
+    context.setOutput('some output', 1.01);
+    assertWriteCalls([`::set-output name=some output::1.01${os.EOL}`]);
+  });
+});
+
+// Assert that process.stdout.write calls called only with the given arguments.
+function assertWriteCalls(calls: string[]): void {
+  expect(process.stdout.write).toHaveBeenCalledTimes(calls.length);
+  for (let i = 0; i < calls.length; i++) {
+    expect(process.stdout.write).toHaveBeenNthCalledWith(i + 1, calls[i]);
+  }
+}
--- a/action.yml
+++ b/action.yml
@ -27,6 +27,12 @@ inputs:
    default: 'false'
    required: false

+outputs:
+  artifacts:
+    description: 'Build result artifacts'
+  metadata:
+    description: 'Build result metadata'
+
 runs:
  using: 'node12'
  main: 'dist/index.js'
--- a/dist/index.js
+++ b/dist/index.js
--- a/package.json
+++ b/package.json
@ -24,7 +24,9 @@
    "@actions/core": "^1.6.0",
    "@actions/exec": "^1.1.0",
    "@actions/http-client": "^1.0.11",
-    "@actions/tool-cache": "^1.7.1"
+    "@actions/tool-cache": "^1.7.1",
+    "js-yaml": "^4.1.0",
+    "yargs": "^17.3.1"
  },
  "devDependencies": {
    "@types/jest": "^26.0.24",
--- a/src/context.ts
+++ b/src/context.ts
@ -1,5 +1,6 @@
 import * as os from 'os';
 import * as core from '@actions/core';
+import {issueCommand} from '@actions/core/lib/command';

 export const osPlat: string = os.platform();
 export const osArch: string = os.arch();
@ -21,3 +22,8 @@ export async function getInputs(): Promise<Inputs> {
    installOnly: core.getBooleanInput('install-only')
  };
 }
+
+// FIXME: Temp fix https://github.com/actions/toolkit/issues/777
+export function setOutput(name: string, value: any): void {
+  issueCommand('set-output', {name}, value);
+}
--- a/src/goreleaser.ts
+++ b/src/goreleaser.ts
@ -1,5 +1,7 @@
+import * as fs from 'fs';
 import * as path from 'path';
 import * as util from 'util';
+import yaml from 'js-yaml';
 import * as context from './context';
 import * as github from './github';
 import * as core from '@actions/core';
@ -78,3 +80,32 @@ const getFilename = (distribution: string): string => {
  const suffix: string = distribSuffix(distribution);
  return util.format('goreleaser%s_%s_%s.%s', suffix, platform, arch, ext);
 };
+
+export async function getDistPath(yamlfile: string): Promise<string> {
+  const cfg = yaml.load(yamlfile);
+  return cfg.dist || 'dist';
+}
+
+export async function getArtifacts(distpath: string): Promise<string | undefined> {
+  const artifactsFile = path.join(distpath, 'artifacts.json');
+  if (!fs.existsSync(artifactsFile)) {
+    return undefined;
+  }
+  const content = fs.readFileSync(artifactsFile, {encoding: 'utf-8'}).trim();
+  if (content === 'null') {
+    return undefined;
+  }
+  return content;
+}
+
+export async function getMetadata(distpath: string): Promise<string | undefined> {
+  const metadataFile = path.join(distpath, 'metadata.json');
+  if (!fs.existsSync(metadataFile)) {
+    return undefined;
+  }
+  const content = fs.readFileSync(metadataFile, {encoding: 'utf-8'}).trim();
+  if (content === 'null') {
+    return undefined;
+  }
+  return content;
+}
--- a/src/main.ts
+++ b/src/main.ts
@ -1,4 +1,6 @@
+import * as fs from 'fs';
 import * as path from 'path';
+import yargs from 'yargs';
 import * as context from './context';
 import * as git from './git';
 import * as goreleaser from './goreleaser';
@ -30,6 +32,18 @@ async function run(): Promise<void> {
    const tag = await git.getTag();
    const isTagDirty = await git.isTagDirty(tag);

+    let yamlfile: string | unknown;
+    const argv = yargs.parse(inputs.args);
+    if (argv.config) {
+      yamlfile = argv.config;
+    } else {
+      ['.goreleaser.yaml', '.goreleaser.yml', 'goreleaser.yaml', 'goreleaser.yml'].forEach(f => {
+        if (fs.existsSync(f)) {
+          yamlfile = f;
+        }
+      });
+    }
+
    let snapshot = '';
    if (inputs.args.split(' ').indexOf('release') > -1) {
      if (isTagDirty) {
@ -49,6 +63,23 @@ async function run(): Promise<void> {
        [key: string]: string;
      }
    });
+
+    if (typeof yamlfile === 'string') {
+      const artifacts = await goreleaser.getArtifacts(await goreleaser.getDistPath(yamlfile));
+      if (artifacts) {
+        await core.group(`Artifacts output`, async () => {
+          core.info(artifacts);
+          context.setOutput('artifacts', artifacts);
+        });
+      }
+      const metadata = await goreleaser.getMetadata(await goreleaser.getDistPath(yamlfile));
+      if (metadata) {
+        await core.group(`Metadata output`, async () => {
+          core.info(metadata);
+          context.setOutput('metadata', metadata);
+        });
+      }
+    }
  } catch (error) {
    core.setFailed(error.message);
  }
--- a/yarn.lock
+++ b/yarn.lock
@ -698,7 +698,7 @@ ansi-escapes@^4.2.1:
  dependencies:
    type-fest "^0.21.3"

-ansi-regex@^5.0.0:
+ansi-regex@^5.0.0, ansi-regex@^5.0.1:
  version "5.0.1"
  resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304"
  integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==
@ -740,6 +740,11 @@ argparse@^1.0.7:
  dependencies:
    sprintf-js "~1.0.2"

+argparse@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38"
+  integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==
+
 arr-diff@^4.0.0:
  version "4.0.0"
  resolved "https://registry.yarnpkg.com/arr-diff/-/arr-diff-4.0.0.tgz#d6461074febfec71e7e15235761a329a5dc7c520"
@ -1013,6 +1018,15 @@ cliui@^6.0.0:
    strip-ansi "^6.0.0"
    wrap-ansi "^6.2.0"

+cliui@^7.0.2:
+  version "7.0.4"
+  resolved "https://registry.yarnpkg.com/cliui/-/cliui-7.0.4.tgz#a0265ee655476fc807aea9df3df8df7783808b4f"
+  integrity sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==
+  dependencies:
+    string-width "^4.2.0"
+    strip-ansi "^6.0.0"
+    wrap-ansi "^7.0.0"
+
 co@^4.6.0:
  version "4.6.0"
  resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184"
@ -1494,7 +1508,7 @@ gensync@^1.0.0-beta.2:
  resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0"
  integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==

-get-caller-file@^2.0.1:
+get-caller-file@^2.0.1, get-caller-file@^2.0.5:
  version "2.0.5"
  resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e"
  integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==
@ -2294,6 +2308,13 @@ js-yaml@^3.13.1:
    argparse "^1.0.7"
    esprima "^4.0.0"

+js-yaml@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602"
+  integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==
+  dependencies:
+    argparse "^2.0.1"
+
 jsdom@^16.4.0:
  version "16.6.0"
  resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-16.6.0.tgz#f79b3786682065492a3da6a60a4695da983805ac"
@ -3184,6 +3205,15 @@ string-width@^4.1.0, string-width@^4.2.0:
    is-fullwidth-code-point "^3.0.0"
    strip-ansi "^6.0.0"

+string-width@^4.2.3:
+  version "4.2.3"
+  resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
+  integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
+  dependencies:
+    emoji-regex "^8.0.0"
+    is-fullwidth-code-point "^3.0.0"
+    strip-ansi "^6.0.1"
+
 strip-ansi@^6.0.0:
  version "6.0.0"
  resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.0.tgz#0b1571dd7669ccd4f3e06e14ef1eed26225ae532"
@ -3191,6 +3221,13 @@ strip-ansi@^6.0.0:
  dependencies:
    ansi-regex "^5.0.0"

+strip-ansi@^6.0.1:
+  version "6.0.1"
+  resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
+  integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==
+  dependencies:
+    ansi-regex "^5.0.1"
+
 strip-bom@^4.0.0:
  version "4.0.0"
  resolved "https://registry.yarnpkg.com/strip-bom/-/strip-bom-4.0.0.tgz#9c3505c1db45bcedca3d9cf7a16f5c5aa3901878"
@ -3533,6 +3570,15 @@ wrap-ansi@^6.2.0:
    string-width "^4.1.0"
    strip-ansi "^6.0.0"

+wrap-ansi@^7.0.0:
+  version "7.0.0"
+  resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
+  integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==
+  dependencies:
+    ansi-styles "^4.0.0"
+    string-width "^4.1.0"
+    strip-ansi "^6.0.0"
+
 wrappy@1:
  version "1.0.2"
  resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f"
@ -3568,6 +3614,11 @@ y18n@^4.0.0:
  resolved "https://registry.yarnpkg.com/y18n/-/y18n-4.0.3.tgz#b5f259c82cd6e336921efd7bfd8bf560de9eeedf"
  integrity sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==

+y18n@^5.0.5:
+  version "5.0.8"
+  resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55"
+  integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==
+
 yallist@^2.1.2:
  version "2.1.2"
  resolved "https://registry.yarnpkg.com/yallist/-/yallist-2.1.2.tgz#1c11f9218f076089a47dd512f93c6699a6a81d52"
@ -3591,6 +3642,11 @@ yargs-parser@^18.1.2:
    camelcase "^5.0.0"
    decamelize "^1.2.0"

+yargs-parser@^21.0.0:
+  version "21.0.1"
+  resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.0.1.tgz#0267f286c877a4f0f728fceb6f8a3e4cb95c6e35"
+  integrity sha512-9BK1jFpLzJROCI5TzwZL/TU4gqjK5xiHV/RfWLOahrjAko/e4DJkRDZQXfvqAsiZzzYhgAzbgz6lg48jcm4GLg==
+
 yargs@^15.4.1:
  version "15.4.1"
  resolved "https://registry.yarnpkg.com/yargs/-/yargs-15.4.1.tgz#0d87a16de01aee9d8bec2bfbf74f67851730f4f8"
@ -3607,3 +3663,16 @@ yargs@^15.4.1:
    which-module "^2.0.0"
    y18n "^4.0.0"
    yargs-parser "^18.1.2"
+
+yargs@^17.3.1:
+  version "17.3.1"
+  resolved "https://registry.yarnpkg.com/yargs/-/yargs-17.3.1.tgz#da56b28f32e2fd45aefb402ed9c26f42be4c07b9"
+  integrity sha512-WUANQeVgjLbNsEmGk20f+nlHgOqzRFpiGWVaBrYGYIGANIIu3lWjoyi0fNlFmJkvfhCZ6BXINe7/W2O2bV4iaA==
+  dependencies:
+    cliui "^7.0.2"
+    escalade "^3.1.1"
+    get-caller-file "^2.0.5"
+    require-directory "^2.1.1"
+    string-width "^4.2.3"
+    y18n "^5.0.5"
+    yargs-parser "^21.0.0"