feat: delete specific deployment

Author: radiantspace

.github/workflows/test.yml

@@ -33,3 +33,8 @@ jobs:
         type: finish
         status: success
         deployment_id: ${{steps.create.outputs.deployment_id}}
+    - uses: ./
+      with:
+        token: ${{github.token}}
+        type: delete
+        deployment_id: ${{steps.create.outputs.deployment_id}}

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 'status'
+    description: a type of deployment action to perform, can be 'create', 'delete', 'delete-all' and 'finish'
   logs:
     required: false
     description: url to deployment logs
@@ -16,7 +16,7 @@ inputs:
     description: description of a deployment
   deployment_id:
     required: false
-    description: an id for deployment if 'delete' or 'status' type is used
+    description: an id for deployment if 'delete' or 'finish' type is used
 runs:
   using: 'node12'
   main: 'dist/index.js'

dist/index.js

@@ -3531,6 +3531,7 @@ 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) {
@@ -3602,6 +3603,13 @@ function run() {
                 }
                 break;
             case 'delete':
+                try {
+                    yield delete_1.deleteDeployment(client, Number(deploymentId));
+                }
+                catch (error) {
+                    core.error(error);
+                    throw error;
+                }
                 break;
             case 'delete-all':
                 try {
@@ -8481,6 +8489,40 @@ function getPageLinks (link) {
 }
 
 
+/***/ }),
+
+/***/ 583:
+/***/ (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.deleteDeployment = void 0;
+const github_1 = __webpack_require__(469);
+function deleteDeployment(client, deploymentId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // invalidate deployment first
+        // since we can't delete active deployment
+        console.log(`invalidate deployment: ${deploymentId}`);
+        const status = yield client.repos.createDeploymentStatus(Object.assign(Object.assign({}, github_1.context.repo), { deployment_id: deploymentId, state: 'failure' }));
+        // then delete it
+        const deploymentUrl = status.data.deployment_url;
+        console.log(`delete deployment: ${deploymentUrl}`);
+        yield client.request(deploymentUrl, { method: 'DELETE' });
+    });
+}
+exports.deleteDeployment = deleteDeployment;
+
+
 /***/ }),
 
 /***/ 605:

src/delete.ts

@@ -0,0 +1,20 @@
+import { context, GitHub } from '@actions/github'
+
+export async function deleteDeployment (
+  client: GitHub,
+  deploymentId: number
+): Promise<void> {
+  // invalidate deployment first
+  // since we can't delete active deployment
+  console.log(`invalidate deployment: ${deploymentId}`)
+  const status = await client.repos.createDeploymentStatus({
+    ...context.repo,
+    deployment_id: deploymentId,
+    state: 'failure'
+  })
+
+  // then delete it
+  const deploymentUrl = status.data.deployment_url
+  console.log(`delete deployment: ${deploymentUrl}`)
+  await client.request(deploymentUrl, { method: 'DELETE' })
+}

src/main.ts

@@ -3,6 +3,8 @@ import * as github from '@actions/github'
 import { create } from './create'
 import { finish } from './finish'
 import { deleteAll } from './delete-all'
+import { deleteDeployment } from './delete'
+
 import { DeploymentStatus } from './deployment-status'
 
 type ActionType = 'create' | 'delete' | 'delete-all' | 'finish'
@@ -99,6 +101,15 @@ export async function run (): Promise<void> {
       }
       break
     case 'delete':
+      try {
+        await deleteDeployment(
+          client,
+          Number(deploymentId)
+        )
+      } catch (error) {
+        core.error(error)
+        throw error
+      }
       break
     case 'delete-all':
       try {

tests/main.test.ts

@@ -163,3 +163,53 @@ describe('delete-all', () => {
     deleteDeployment.done()
   })
 })
+
+describe('delete-all', () => {
+  beforeEach(() => {
+    process.env['GITHUB_REPOSITORY'] = 'owner/repo'
+
+    let inputs = {} as any
+    let inputSpy: jest.SpyInstance;
+
+    // @actions/core
+    inputs = {
+      'token': 'fake-token',
+      'type': 'delete',
+      'deployment_id': '42'
+    }
+    inputSpy = jest.spyOn(core, 'getInput');
+    inputSpy.mockImplementation(name => inputs[name]);
+
+    // @actions/github
+    Object.defineProperty(github.context, 'actor', { get: () => 'fake-actor' })
+    Object.defineProperty(github.context, 'ref', { get: () => 'refs/heads/master' })
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks();
+    jest.clearAllMocks();
+  })
+
+  it('200', async () => {
+    // arrange
+    const postStatus = nock('https://api.github.com')
+      .post('/repos/owner/repo/deployments/42/statuses')
+      .reply(200, { deployment_url: 'https://api.github.com/repos/owner/repo/deployments/42' })
+
+    const deleteDeployment = nock('https://api.github.com')
+      .delete('/repos/owner/repo/deployments/42')
+      .reply(200)
+
+    // act
+    try {
+      await main.run()
+    } catch (error) {
+      console.error(JSON.stringify(error.toString(), null, 2))
+      console.error(JSON.stringify(error.stack, null, 2))
+    }
+
+    // assert
+    postStatus.done()
+    deleteDeployment.done()
+  })
+})