feat(delete-deployment): also delete environment (#201)

README.md

@@ -68,7 +68,7 @@ Each of the following helpers are defined in a file of the same name in `src/hel
   * Comments on a pull request or other issue
 
 ### [delete-deployment](.github/workflows/deployments.yml#L53)
-* Deletes a Github [deployment](https://docs.github.com/en/rest/reference/repos#deployments)
+* Deletes a Github [deployment](https://docs.github.com/en/rest/reference/repos#deployments) and [environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#about-environments)
 
 ### [filter-paths](.github/workflows/filter-paths.yml)
   * Returns `true` if specified file paths have changed for a PR, and `false` otherwise

src/helpers/delete-deployment.ts

@@ -35,10 +35,17 @@ export const deleteDeployment = async ({ sha, environment }: DeleteDeployment) =
       ...context.repo,
       ...GITHUB_OPTIONS
     });
-    return octokit.repos.deleteDeployment({
-      deployment_id,
-      ...context.repo,
-      ...GITHUB_OPTIONS
-    });
+    return Promise.all([
+      octokit.repos.deleteDeployment({
+        deployment_id,
+        ...context.repo,
+        ...GITHUB_OPTIONS
+      }),
+      octokit.repos.deleteAnEnvironment({
+        environment_name: environment,
+        ...context.repo,
+        ...GITHUB_OPTIONS
+      })
+    ]);
   }
 };

test/helpers/delete-deployment.test.ts

@@ -25,6 +25,7 @@ jest.mock('@actions/github', () => ({
       repos: {
         createDeploymentStatus: jest.fn(),
         deleteDeployment: jest.fn(),
+        deleteAnEnvironment: jest.fn(),
         listDeployments: jest.fn()
       }
     }
@@ -79,6 +80,14 @@ describe('deleteDeployment', () => {
         ...GITHUB_OPTIONS
       });
     });
+
+    it('should call deleteAnEnvironment with correct params', () => {
+      expect(octokit.repos.deleteAnEnvironment).toHaveBeenCalledWith({
+        environment_name: environment,
+        ...context.repo,
+        ...GITHUB_OPTIONS
+      });
+    });
   });
 
   describe('deployment does not exist', () => {
@@ -108,5 +117,9 @@ describe('deleteDeployment', () => {
     it('should not call deleteDeployment', () => {
       expect(octokit.repos.deleteDeployment).not.toHaveBeenCalled();
     });
+
+    it('should not call deleteAnEnvironment', () => {
+      expect(octokit.repos.deleteAnEnvironment).not.toHaveBeenCalled();
+    });
   });
 });