feat: use post script to complete deployment (#4)

Author: radiantspace

.github/workflows/test.yml

@@ -23,6 +23,7 @@ jobs:
       with:
         token: ${{github.token}}
         type: delete-all
+        environment: test
     - uses: ./
       name: Create first deployment
       id: create-first
@@ -32,13 +33,7 @@ jobs:
         environment: test
         logs: https://github.com/npm/action-deploy/actions?query=workflow%3Abuild-test
         environment_url: https://npmjs.com
-    - uses: ./
-      name: Finish first deployment with success
-      with:
-        token: ${{github.token}}
-        type: finish
-        status: success
-        deployment_id: ${{steps.create-first.outputs.deployment_id}}
+        job_status: ${{job.status}}
     - uses: ./
       name: Delete first deployment
       with:
@@ -54,10 +49,4 @@ jobs:
         environment: test
         logs: https://github.com/npm/action-deploy/actions?query=workflow%3Abuild-test
         environment_url: https://npmjs.com
-    - uses: ./
-      name: Finish second deployment
-      with:
-        token: ${{github.token}}
-        type: finish
-        status: success
-        deployment_id: ${{steps.create-second.outputs.deployment_id}}
+        job_status: ${{job.status}}

README.md

@@ -2,7 +2,6 @@
 
 Features:
 - create a deployment (and invalidate all previous deployments)
-- finish a deployment (with success/failure state)
 - delete all deployments in specific environment
 - delete a deployment by id
 
@@ -17,9 +16,10 @@ Inputs:
 `token`|**Required** token to authorize calls to GitHub API, can be ${{github.token}} to create a deployment for the same repo
 `type`|**Required** type of an action. Should be `create` to create a deployment
 `logs`|url to the deployment logs
-`environment`|environment to create a deployments in, default to `context.ref` without prefixes (`'refs/heads/'`, `'deploy-'`), i.e. branch name
+`environment`|environment to create a deployments in, default to `$context.ref` without prefixes (`'refs/heads/'`, `'deploy-'`), i.e. branch name
 `environment_url`|link to the deployed application
 `description`|optional description, defaults to `"deployed by $context.actor"`
+`job_status`|pass `${{job.status}}` to set the deployment completion status post script accordingly
 
 Outputs:
 
@@ -38,47 +38,7 @@ Outputs:
     logs: https://your-app.com/deployment_logs
     environment: staging
     environment_url: https://staging.your-app.com
-```
-
-### finish
-
-Given in one of the previous steps you created a deployment, with `finish` you can set a status upon a deployment completion
-
-Inputs:
-
-|parameter | description
-|- | -
-`token` | **Required** token to authorize calls to GitHub API, can be ${{github.token}} to create a deployment for the same repo
-`type` | **Required** type of an action. Should be `finish`
-`deployment_id` | **Required** the `id` of the a deployment to finish
-`status` | can be any status, e.g. failure/success
-
-Outputs: none
-
-#### Example usage
-
-```yaml
-- name: create a deployment
-  uses: npm/action-deploy@v1
-  id: create-deployment
-  with:
-    type: create
-    token: ${{github.token}}
-    logs: https://your-app.com/deployment_logs
-    environment: staging
-    environment_url: https://staging.your-app.com
-
-# add your deployment steps here
-- name: placeholder for actual deployment
-  run: sleep 10s
-
-- name: finish deployment
-  uses: npm/action-deploy@v1
-  with:
-    type: finish
-    token: ${{github.token}}
-    status: success
-    deployment_id: ${{steps.create-deployment.outputs.deployment_id}}
+    job_status: ${{job.status}} # use this to track success of the deployment in post script
 ```
 
 ### delete-all

action.yml

@@ -7,7 +7,7 @@ inputs:
     description: GitHub token
   type:
     required: true
-    description: a type of deployment action to perform, can be 'create', 'delete', 'delete-all' and 'finish'
+    description: a type of deployment action to perform, can be 'create', 'delete' and 'delete-all'
   logs:
     required: false
     description: url to deployment logs
@@ -16,10 +16,10 @@ inputs:
     description: description of a deployment
   deployment_id:
     required: false
-    description: an id for deployment if 'delete' or 'finish' type is used
+    description: an id for deployment if 'delete' type is used
   status:
     required: false
-    description: status for created or finished deployment
+    description: status for created deployment
   environment:
     required: false
     description: environment to create or delete all deployments in, default to context.ref without prefixes ('refs/heads/', 'deploy-'), i.e. branch name
@@ -29,6 +29,10 @@ inputs:
   main_branch:
     required: false
     description: name of main branch of the repo, to get and store sha of the head commit and track diff being deployed
+  job_status:
+    required: false
+    description: pass `{{job.status}}` to set the deployment completion status post script accordingly
 runs:
   using: 'node12'
-  main: 'dist/index.js'
+  main: 'dist/main/index.js'
+  post: 'dist/post/index.js'

dist/index.js renamed to dist/main/index.js

@@ -3529,18 +3529,9 @@ exports.run = void 0;
 const core = __importStar(__webpack_require__(470));
 const github = __importStar(__webpack_require__(469));
 const create_1 = __webpack_require__(646);
-const finish_1 = __webpack_require__(209);
 const delete_all_1 = __webpack_require__(832);
 const delete_1 = __webpack_require__(583);
-// nullify getInput empty results
-// to allow coalescence ?? operator
-function getInput(name, options) {
-    const result = core.getInput(name, options);
-    if (result === '') {
-        return null;
-    }
-    return result;
-}
+const utils_1 = __webpack_require__(611);
 function run() {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     return __awaiter(this, void 0, void 0, function* () {
@@ -3554,30 +3545,30 @@ function run() {
         let deploymentId;
         let mainBranch;
         const { actor, ref } = github.context;
-        console.log('### context ###');
+        console.log('### main.context ###');
         console.log(`actor: ${actor}`);
         console.log(`ref: ${ref}`);
         console.log('\n');
         try {
-            console.log('### inputs ###');
-            token = (_a = getInput('token', { required: true })) !== null && _a !== void 0 ? _a : '';
-            type = getInput('type', { required: true });
+            console.log('### main.inputs ###');
+            token = (_a = utils_1.getInput('token', { required: true })) !== null && _a !== void 0 ? _a : '';
+            type = utils_1.getInput('type', { required: true });
             console.log(`type: ${type}`);
-            logsUrl = (_b = getInput('logs')) !== null && _b !== void 0 ? _b : '';
+            logsUrl = (_b = utils_1.getInput('logs')) !== null && _b !== void 0 ? _b : '';
             console.log(`logs: ${logsUrl}`);
-            description = (_c = getInput('description')) !== null && _c !== void 0 ? _c : `deployed by ${actor}`;
+            description = (_c = utils_1.getInput('description')) !== null && _c !== void 0 ? _c : `deployed by ${actor}`;
             console.log(`description: ${description}`);
-            status = ((_d = getInput('status')) !== null && _d !== void 0 ? _d : 'in_progress');
+            status = ((_d = utils_1.getInput('status')) !== null && _d !== void 0 ? _d : 'in_progress');
             console.log(`status: ${status}`);
             // default to branch name w/o `deploy-` prefix
-            environment = (_e = getInput('environment')) !== null && _e !== void 0 ? _e : ref.replace('refs/heads/', '').replace(/^deploy-/, '');
+            environment = (_e = utils_1.getInput('environment')) !== null && _e !== void 0 ? _e : ref.replace('refs/heads/', '').replace(/^deploy-/, '');
             console.log(`environment: ${environment}`);
-            environmentUrl = (_f = getInput('environment_url')) !== null && _f !== void 0 ? _f : '';
+            environmentUrl = (_f = utils_1.getInput('environment_url')) !== null && _f !== void 0 ? _f : '';
             console.log(`environmentUrl: ${environmentUrl}`);
-            mainBranch = (_g = getInput('main_branch')) !== null && _g !== void 0 ? _g : 'master';
+            mainBranch = (_g = utils_1.getInput('main_branch')) !== null && _g !== void 0 ? _g : 'master';
             console.log(`main branch: ${mainBranch}`);
-            const shouldRequireDeploymentId = type === 'finish' || type === 'delete';
-            deploymentId = (_h = getInput('deployment_id', { required: shouldRequireDeploymentId })) !== null && _h !== void 0 ? _h : '0';
+            const shouldRequireDeploymentId = type === 'delete';
+            deploymentId = (_h = utils_1.getInput(utils_1.DEPLOYMENT_ID_STATE_NAME, { required: shouldRequireDeploymentId })) !== null && _h !== void 0 ? _h : '0';
             console.log(`deploymentId: ${deploymentId}`);
         }
         catch (error) {
@@ -3592,25 +3583,16 @@ function run() {
             case 'create':
                 try {
                     deploymentId = yield create_1.create(client, logsUrl, description, status, environment, environmentUrl, mainBranch);
-                    console.log(`setOutput::deployment_id: ${deploymentId}`);
-                    core.setOutput('deployment_id', deploymentId);
+                    console.log(`saveState::${utils_1.DEPLOYMENT_ID_STATE_NAME}: ${deploymentId}`);
+                    core.saveState(utils_1.DEPLOYMENT_ID_STATE_NAME, deploymentId); // for internal use
+                    core.setOutput(utils_1.DEPLOYMENT_ID_STATE_NAME, deploymentId); // keep that output for external dependencies
                 }
                 catch (error) {
                     core.error(error);
                     core.setFailed(`Create deployment failed: ${JSON.stringify(error, null, 2)}`);
                     throw error;
                 }
                 break;
-            case 'finish':
-                try {
-                    yield finish_1.finish(client, Number(deploymentId), status);
-                }
-                catch (error) {
-                    core.error(error);
-                    core.setFailed(`Finish deployment failed: ${JSON.stringify(error, null, 2)}`);
-                    throw error;
-                }
-                break;
             case 'delete':
                 try {
                     yield delete_1.deleteDeployment(client, Number(deploymentId));
@@ -3639,37 +3621,6 @@ if (process.env.NODE_ENV !== 'test')
     run(); // eslint-disable-line @typescript-eslint/no-floating-promises
 
 
-/***/ }),
-
-/***/ 209:
-/***/ (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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.finish = void 0;
-const github_1 = __webpack_require__(469);
-function finish(client, deploymentId, status) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const statuses = yield client.repos.listDeploymentStatuses(Object.assign(Object.assign({}, github_1.context.repo), { deployment_id: deploymentId }));
-        const lastStatus = statuses.data.sort((a, b) => a.id - b.id).slice(-1)[0];
-        console.log(`last status for deployment_id '${deploymentId}': ${JSON.stringify(lastStatus, null, 2)}`);
-        const statusResult = yield client.repos.createDeploymentStatus(Object.assign(Object.assign({}, github_1.context.repo), { deployment_id: deploymentId, state: status, environment_url: lastStatus.environment_url, log_url: lastStatus.log_url }));
-        console.log(`created deployment status: ${JSON.stringify(statusResult.data, null, 2)}`);
-    });
-}
-exports.finish = finish;
-
-
 /***/ }),
 
 /***/ 211:
@@ -8544,6 +8495,48 @@ exports.deleteDeployment = deleteDeployment;
 
 module.exports = require("http");
 
+/***/ }),
+
+/***/ 611:
+/***/ (function(__unusedmodule, exports, __webpack_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInput = exports.DEPLOYMENT_ID_STATE_NAME = void 0;
+const core = __importStar(__webpack_require__(470));
+exports.DEPLOYMENT_ID_STATE_NAME = 'deployment_id';
+// nullify getInput empty results
+// to allow coalescence ?? operator
+function getInput(name, options) {
+    const result = core.getInput(name, options);
+    if (result === '') {
+        return null;
+    }
+    return result;
+}
+exports.getInput = getInput;
+
+
 /***/ }),
 
 /***/ 614: