feat: delete all deployments

Author: radiantspace

.github/workflows/test.yml

@@ -18,6 +18,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
+    - uses: ./
+      with:
+        token: ${{github.token}}
+        type: delete-all
     - uses: ./
       id: create
       with:

src/delete-all.ts

@@ -0,0 +1,26 @@
+import { context, GitHub } from '@actions/github'
+
+export async function deleteAll (
+  client: GitHub,
+  environment: string
+): Promise<void> {
+  const deployments = await client.repos.listDeployments({
+    ...context.repo,
+    environment
+  })
+
+  await Promise.all(deployments.data.map(async (deployment) => {
+    // invalidate deployment first
+    // since we can't delete active deployment
+    console.log(`invalidate deployment: ${deployment.id}`)
+    await client.repos.createDeploymentStatus({
+      ...context.repo,
+      deployment_id: deployment.id,
+      state: 'failure'
+    });
+
+    // then delete it
+    console.log(`delete deployment: ${deployment.url}`)
+    await client.request(deployment.url, { "method": "DELETE" })
+  }))
+}

src/finish.ts

@@ -3,14 +3,14 @@ import { DeploymentStatus } from './deployment-status'
 
 export async function finish (
   client: GitHub,
-  deploymentId: string,
+  deploymentId: number,
   status: DeploymentStatus,
   logUrl: string,
   environmentUrl: string
 ): Promise<void> {
   const statusResult = await client.repos.createDeploymentStatus({
     ...context.repo,
-    deployment_id: Number(deploymentId),
+    deployment_id: deploymentId,
     state: status,
     log_url: logUrl,
     environment_url: environmentUrl

src/main.ts

@@ -2,6 +2,7 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import { create } from './create'
 import { finish } from './finish'
+import { deleteAll } from './delete-all'
 import { DeploymentStatus } from './deployment-status'
 
 type ActionType = 'create' | 'delete' | 'delete-all' | 'finish'
@@ -80,28 +81,35 @@ export async function run (): Promise<void> {
         core.setOutput('deployment_id', deploymentId)
       } catch (error) {
         core.error(error)
-        // core.setFailed(error)
         throw error
       }
       break
     case 'finish':
       try {
         await finish(
           client,
-          deploymentId,
+          Number(deploymentId),
           status,
           logsUrl,
           environmentUrl
         )
       } catch (error) {
         core.error(error)
-        // core.setFailed(`Could not finish a deployment: ${JSON.stringify(error, null, 2)}`)
         throw error
       }
       break
     case 'delete':
       break
     case 'delete-all':
+      try {
+        await deleteAll(
+          client,
+          environment
+        )
+      } catch (error) {
+        core.error(error)
+        throw error
+      }
       break
   }
 }

tests/main.test.ts

@@ -108,3 +108,58 @@ describe('finish', () => {
     postDeploymentStatus.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-all',
+      'environment': 'staging'
+    }
+    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 getListDeployments = nock('https://api.github.com')
+      .get('/repos/owner/repo/deployments?environment=staging')
+      .reply(200, [{ id: 42, url: 'https://api.github.com/repos/owner/repo/deployments/42' }])
+
+    const postStatus = nock('https://api.github.com')
+      .post('/repos/owner/repo/deployments/42/statuses')
+      .reply(200, postStatusReply)
+
+    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
+    getListDeployments.done()
+    postStatus.done()
+    deleteDeployment.done()
+  })
+})