From fba151b9d90f171f3a4ebdaa18f730cf0dda8356 Mon Sep 17 00:00:00 2001 From: Franz Diebold Date: Mon, 13 Jul 2020 12:12:00 +0200 Subject: [PATCH] Switch to JavaScript action. --- Dockerfile | 8 - README.md | 7 +- action.yml | 4 +- dist/index.js | 427 ++++++++++++++++++++++++++++++++++++++++++++++ entrypoint.sh | 17 -- index.js | 32 ++++ package-lock.json | 13 ++ package.json | 27 +++ 8 files changed, 505 insertions(+), 30 deletions(-) delete mode 100644 Dockerfile create mode 100644 dist/index.js delete mode 100755 entrypoint.sh create mode 100644 index.js create mode 100644 package-lock.json create mode 100644 package.json diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index fa0188a..0000000 --- a/Dockerfile +++ /dev/null @@ -1,8 +0,0 @@ -# Container image that runs your code -FROM alpine:3.10 - -# Copies your code file from your action repository to the filesystem path `/` of the container -COPY entrypoint.sh /entrypoint.sh - -# Code file to execute when the docker container starts up (`entrypoint.sh`) -ENTRYPOINT ["/entrypoint.sh"] diff --git a/README.md b/README.md index d7a5736..d83f3ab 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # :octocat: :rocket: GitHub Environment Variables Action -A [GitHub Action](https://github.com/features/actions) to expose useful environment variables. +[![license: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](./LICENSE) +[version](https://img.shields.io/github/package-json/v/FranzDiebold/github-env-vars-action) -> This action is only supported on Linux! Currently, there is no support for Windows or macOS. +A [GitHub Action](https://github.com/features/actions) to expose useful environment variables. ### Environment Variables exposed by **this Action** @@ -29,7 +30,7 @@ For a full list of default environment variables exposed by GitHub see [https:// ```yaml steps: - - uses: franzdiebold/github-env-vars-action@v1.0.0 + - uses: franzdiebold/github-env-vars-action@v1.1.0 - name: Print environment variables run: | echo "GITHUB_REPOSITORY_OWNER=$GITHUB_REPOSITORY_OWNER" diff --git a/action.yml b/action.yml index 8e93c63..6c8823f 100644 --- a/action.yml +++ b/action.yml @@ -2,8 +2,8 @@ name: 'GitHub Environment Variables Action' description: 'Expose useful Environment Variables.' author: 'Franz Diebold' runs: - using: 'docker' - image: 'Dockerfile' + using: 'node12' + main: 'dist/index.js' branding: icon: 'plus-circle' color: 'green' diff --git a/dist/index.js b/dist/index.js new file mode 100644 index 0000000..a05698b --- /dev/null +++ b/dist/index.js @@ -0,0 +1,427 @@ +module.exports = +/******/ (function(modules, runtime) { // webpackBootstrap +/******/ "use strict"; +/******/ // The module cache +/******/ var installedModules = {}; +/******/ +/******/ // The require function +/******/ function __webpack_require__(moduleId) { +/******/ +/******/ // Check if module is in cache +/******/ if(installedModules[moduleId]) { +/******/ return installedModules[moduleId].exports; +/******/ } +/******/ // Create a new module (and put it into the cache) +/******/ var module = installedModules[moduleId] = { +/******/ i: moduleId, +/******/ l: false, +/******/ exports: {} +/******/ }; +/******/ +/******/ // Execute the module function +/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); +/******/ +/******/ // Flag the module as loaded +/******/ module.l = true; +/******/ +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } +/******/ +/******/ +/******/ __webpack_require__.ab = __dirname + "/"; +/******/ +/******/ // the startup function +/******/ function startup() { +/******/ // Load entry module and return exports +/******/ return __webpack_require__(622); +/******/ }; +/******/ +/******/ // run startup +/******/ return startup(); +/******/ }) +/************************************************************************/ +/******/ ({ + +/***/ 87: +/***/ (function(module) { + +module.exports = require("os"); + +/***/ }), + +/***/ 215: +/***/ (function(__unusedmodule, exports, __webpack_require__) { + +"use strict"; + +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; + result["default"] = mod; + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +const os = __importStar(__webpack_require__(87)); +/** + * Commands + * + * Command Format: + * ::name key=value,key=value::message + * + * Examples: + * ::warning::This is the message + * ::set-env name=MY_VAR::some value + */ +function issueCommand(command, properties, message) { + const cmd = new Command(command, properties, message); + process.stdout.write(cmd.toString() + os.EOL); +} +exports.issueCommand = issueCommand; +function issue(name, message = '') { + issueCommand(name, {}, message); +} +exports.issue = issue; +const CMD_STRING = '::'; +class Command { + constructor(command, properties, message) { + if (!command) { + command = 'missing.command'; + } + this.command = command; + this.properties = properties; + this.message = message; + } + toString() { + let cmdStr = CMD_STRING + this.command; + if (this.properties && Object.keys(this.properties).length > 0) { + cmdStr += ' '; + let first = true; + for (const key in this.properties) { + if (this.properties.hasOwnProperty(key)) { + const val = this.properties[key]; + if (val) { + if (first) { + first = false; + } + else { + cmdStr += ','; + } + cmdStr += `${key}=${escapeProperty(val)}`; + } + } + } + } + cmdStr += `${CMD_STRING}${escapeData(this.message)}`; + return cmdStr; + } +} +/** + * Sanitizes an input into a string so it can be passed into issueCommand safely + * @param input input to sanitize into a string + */ +function toCommandValue(input) { + if (input === null || input === undefined) { + return ''; + } + else if (typeof input === 'string' || input instanceof String) { + return input; + } + return JSON.stringify(input); +} +exports.toCommandValue = toCommandValue; +function escapeData(s) { + return toCommandValue(s) + .replace(/%/g, '%25') + .replace(/\r/g, '%0D') + .replace(/\n/g, '%0A'); +} +function escapeProperty(s) { + return toCommandValue(s) + .replace(/%/g, '%25') + .replace(/\r/g, '%0D') + .replace(/\n/g, '%0A') + .replace(/:/g, '%3A') + .replace(/,/g, '%2C'); +} +//# sourceMappingURL=command.js.map + +/***/ }), + +/***/ 277: +/***/ (function(module) { + +module.exports = require("path"); + +/***/ }), + +/***/ 622: +/***/ (function(__unusedmodule, __unusedexports, __webpack_require__) { + +// Franz Diebold + +const core = __webpack_require__(827); + +function slugify(inputString) { + return inputString.replace(/^\s+|\s+$/g, '') // trim + .toLowerCase() + .replace(/[^a-z0-9 -]/g, '') // remove invalid chars + .replace(/\s+/g, '-') // collapse whitespace and replace by - + .replace(/-+/g, '-'); // collapse dashes +} + +// https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables +try { + splitted_github_repository = process.env.GITHUB_REPOSITORY.split('/'); // FranzDiebold/github-env-vars-action + + core.exportVariable('GITHUB_REPOSITORY_OWNER', slugify(splitted_github_repository[0])); + core.info(`Set GITHUB_REPOSITORY_OWNER=${process.env.GITHUB_REPOSITORY_OWNER}`); + + core.exportVariable('GITHUB_REPOSITORY_NAME', slugify(splitted_github_repository[1])); + core.info(`Set GITHUB_REPOSITORY_NAME=${process.env.GITHUB_REPOSITORY_NAME}`); + + splitted_github_ref = process.env.GITHUB_REF.split('/'); // refs/heads/feature-branch-1 + core.exportVariable('GITHUB_REF_NAME', slugify(splitted_github_ref[2])); + core.info(`Set GITHUB_REF_NAME=${process.env.GITHUB_REF_NAME}`); + + github_sha = process.env.GITHUB_SHA; // ffac537e6cbbf934b08745a378932722df287a53 + core.exportVariable('GITHUB_SHA_SHORT', github_sha.substring(0, 8)); + core.info(`Set GITHUB_SHA_SHORT=${process.env.GITHUB_SHA_SHORT}`); +} catch (error) { + core.setFailed(error.message); +} + + +/***/ }), + +/***/ 827: +/***/ (function(__unusedmodule, exports, __webpack_require__) { + +"use strict"; + +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; + result["default"] = mod; + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +const command_1 = __webpack_require__(215); +const os = __importStar(__webpack_require__(87)); +const path = __importStar(__webpack_require__(277)); +/** + * The code to exit an action + */ +var ExitCode; +(function (ExitCode) { + /** + * A code indicating that the action was successful + */ + ExitCode[ExitCode["Success"] = 0] = "Success"; + /** + * A code indicating that the action was a failure + */ + ExitCode[ExitCode["Failure"] = 1] = "Failure"; +})(ExitCode = exports.ExitCode || (exports.ExitCode = {})); +//----------------------------------------------------------------------- +// Variables +//----------------------------------------------------------------------- +/** + * Sets env variable for this action and future actions in the job + * @param name the name of the variable to set + * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +function exportVariable(name, val) { + const convertedVal = command_1.toCommandValue(val); + process.env[name] = convertedVal; + command_1.issueCommand('set-env', { name }, convertedVal); +} +exports.exportVariable = exportVariable; +/** + * Registers a secret which will get masked from logs + * @param secret value of the secret + */ +function setSecret(secret) { + command_1.issueCommand('add-mask', {}, secret); +} +exports.setSecret = setSecret; +/** + * Prepends inputPath to the PATH (for this action and future actions) + * @param inputPath + */ +function addPath(inputPath) { + command_1.issueCommand('add-path', {}, inputPath); + process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`; +} +exports.addPath = addPath; +/** + * Gets the value of an input. The value is also trimmed. + * + * @param name name of the input to get + * @param options optional. See InputOptions. + * @returns string + */ +function getInput(name, options) { + const val = process.env[`INPUT_${name.replace(/ /g, '_').toUpperCase()}`] || ''; + if (options && options.required && !val) { + throw new Error(`Input required and not supplied: ${name}`); + } + return val.trim(); +} +exports.getInput = getInput; +/** + * Sets the value of an output. + * + * @param name name of the output to set + * @param value value to store. Non-string values will be converted to a string via JSON.stringify + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +function setOutput(name, value) { + command_1.issueCommand('set-output', { name }, value); +} +exports.setOutput = setOutput; +/** + * Enables or disables the echoing of commands into stdout for the rest of the step. + * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set. + * + */ +function setCommandEcho(enabled) { + command_1.issue('echo', enabled ? 'on' : 'off'); +} +exports.setCommandEcho = setCommandEcho; +//----------------------------------------------------------------------- +// Results +//----------------------------------------------------------------------- +/** + * Sets the action status to failed. + * When the action exits it will be with an exit code of 1 + * @param message add error issue message + */ +function setFailed(message) { + process.exitCode = ExitCode.Failure; + error(message); +} +exports.setFailed = setFailed; +//----------------------------------------------------------------------- +// Logging Commands +//----------------------------------------------------------------------- +/** + * Gets whether Actions Step Debug is on or not + */ +function isDebug() { + return process.env['RUNNER_DEBUG'] === '1'; +} +exports.isDebug = isDebug; +/** + * Writes debug message to user log + * @param message debug message + */ +function debug(message) { + command_1.issueCommand('debug', {}, message); +} +exports.debug = debug; +/** + * Adds an error issue + * @param message error issue message. Errors will be converted to string via toString() + */ +function error(message) { + command_1.issue('error', message instanceof Error ? message.toString() : message); +} +exports.error = error; +/** + * Adds an warning issue + * @param message warning issue message. Errors will be converted to string via toString() + */ +function warning(message) { + command_1.issue('warning', message instanceof Error ? message.toString() : message); +} +exports.warning = warning; +/** + * Writes info to log with console.log. + * @param message info message + */ +function info(message) { + process.stdout.write(message + os.EOL); +} +exports.info = info; +/** + * Begin an output group. + * + * Output until the next `groupEnd` will be foldable in this group + * + * @param name The name of the output group + */ +function startGroup(name) { + command_1.issue('group', name); +} +exports.startGroup = startGroup; +/** + * End an output group. + */ +function endGroup() { + command_1.issue('endgroup'); +} +exports.endGroup = endGroup; +/** + * Wrap an asynchronous function call in a group. + * + * Returns the same type as the function itself. + * + * @param name The name of the group + * @param fn The function to wrap in the group + */ +function group(name, fn) { + return __awaiter(this, void 0, void 0, function* () { + startGroup(name); + let result; + try { + result = yield fn(); + } + finally { + endGroup(); + } + return result; + }); +} +exports.group = group; +//----------------------------------------------------------------------- +// Wrapper action state +//----------------------------------------------------------------------- +/** + * Saves state for current action, the state can only be retrieved by this action's post job execution. + * + * @param name name of the state to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +function saveState(name, value) { + command_1.issueCommand('save-state', { name }, value); +} +exports.saveState = saveState; +/** + * Gets the value of an state set by this action's main execution. + * + * @param name name of the state to get + * @returns string + */ +function getState(name) { + return process.env[`STATE_${name}`] || ''; +} +exports.getState = getState; +//# sourceMappingURL=core.js.map + +/***/ }) + +/******/ }); \ No newline at end of file diff --git a/entrypoint.sh b/entrypoint.sh deleted file mode 100755 index bbaba5d..0000000 --- a/entrypoint.sh +++ /dev/null @@ -1,17 +0,0 @@ -#!/bin/sh -l - -GITHUB_REPOSITORY_OWNER=$(echo $GITHUB_REPOSITORY | cut -d'/' -f 1) -echo "::set-env name=GITHUB_REPOSITORY_OWNER::$GITHUB_REPOSITORY_OWNER" -echo "Set GITHUB_REPOSITORY_OWNER=$GITHUB_REPOSITORY_OWNER" - -GITHUB_REPOSITORY_NAME=$(echo $GITHUB_REPOSITORY | cut -d'/' -f 2) -echo "::set-env name=GITHUB_REPOSITORY_NAME::$GITHUB_REPOSITORY_NAME" -echo "Set GITHUB_REPOSITORY_NAME=$GITHUB_REPOSITORY_NAME" - -GITHUB_REF_NAME=$(echo $GITHUB_REF | cut -d'/' -f 3) -echo "::set-env name=GITHUB_REF_NAME::$GITHUB_REF_NAME" -echo "Set GITHUB_REF_NAME=$GITHUB_REF_NAME" - -GITHUB_SHA_SHORT=$(echo $GITHUB_SHA | cut -c1-8) -echo "::set-env name=GITHUB_SHA_SHORT::$GITHUB_SHA_SHORT" -echo "Set GITHUB_SHA_SHORT=$GITHUB_SHA_SHORT" diff --git a/index.js b/index.js new file mode 100644 index 0000000..e5ba6b3 --- /dev/null +++ b/index.js @@ -0,0 +1,32 @@ +// Franz Diebold + +const core = require('@actions/core'); + +function slugify(inputString) { + return inputString.replace(/^\s+|\s+$/g, '') // trim + .toLowerCase() + .replace(/[^a-z0-9 -]/g, '') // remove invalid chars + .replace(/\s+/g, '-') // collapse whitespace and replace by - + .replace(/-+/g, '-'); // collapse dashes +} + +// https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables +try { + splitted_github_repository = process.env.GITHUB_REPOSITORY.split('/'); // FranzDiebold/github-env-vars-action + + core.exportVariable('GITHUB_REPOSITORY_OWNER', slugify(splitted_github_repository[0])); + core.info(`Set GITHUB_REPOSITORY_OWNER=${process.env.GITHUB_REPOSITORY_OWNER}`); + + core.exportVariable('GITHUB_REPOSITORY_NAME', slugify(splitted_github_repository[1])); + core.info(`Set GITHUB_REPOSITORY_NAME=${process.env.GITHUB_REPOSITORY_NAME}`); + + splitted_github_ref = process.env.GITHUB_REF.split('/'); // refs/heads/feature-branch-1 + core.exportVariable('GITHUB_REF_NAME', slugify(splitted_github_ref[2])); + core.info(`Set GITHUB_REF_NAME=${process.env.GITHUB_REF_NAME}`); + + github_sha = process.env.GITHUB_SHA; // ffac537e6cbbf934b08745a378932722df287a53 + core.exportVariable('GITHUB_SHA_SHORT', github_sha.substring(0, 8)); + core.info(`Set GITHUB_SHA_SHORT=${process.env.GITHUB_SHA_SHORT}`); +} catch (error) { + core.setFailed(error.message); +} diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..163c364 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,13 @@ +{ + "name": "github-env-vars-action", + "version": "1.1.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "@actions/core": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.4.tgz", + "integrity": "sha512-YJCEq8BE3CdN8+7HPZ/4DxJjk/OkZV2FFIf+DlZTC/4iBlzYCD5yjRR6eiOS5llO11zbRltIRuKAjMKaWTE6cg==" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..a8cc177 --- /dev/null +++ b/package.json @@ -0,0 +1,27 @@ +{ + "name": "github-env-vars-action", + "version": "1.1.0", + "description": "A GitHub Action to expose useful environment variables.", + "main": "index.js", + "scripts": { + "build": "ncc build index.js", + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/FranzDiebold/github-env-vars-action.git" + }, + "keywords": [ + "Environment variables", + "GitHub Action" + ], + "author": "Franz Diebold", + "license": "MIT", + "bugs": { + "url": "https://github.com/FranzDiebold/github-env-vars-action/issues" + }, + "homepage": "https://github.com/FranzDiebold/github-env-vars-action#readme", + "dependencies": { + "@actions/core": "^1.2.4" + } +}