fix(initiate-deployment): don't set commit statuses on merge queue PRs (#694)

Author: danadajian

.github/workflows/deployments.yml

@@ -53,3 +53,4 @@ jobs:
           helper: delete-deployment
           sha: ${{ github.event.pull_request.head.sha }}
           environment: test
+          github_token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

dist/264.index.js

@@ -42996,13 +42996,11 @@ var map = {
 	"./initiate-deployment": [
 		5264,
 		461,
-		366,
 		264
 	],
 	"./initiate-deployment.ts": [
 		5264,
 		461,
-		366,
 		264
 	],
 	"./is-user-core-member": [

dist/264.index.js.map

@@ -12,12 +12,10 @@ limitations under the License.
 */
 
 import { DeploymentState } from '../types/github';
-import { DEFAULT_PIPELINE_STATUS, GITHUB_OPTIONS } from '../constants';
+import { GITHUB_OPTIONS } from '../constants';
 import { HelperInputs } from '../types/generated';
 import { context as githubContext } from '@actions/github';
 import { octokit } from '../octokit';
-import { map } from 'bluebird';
-import { getMergeQueueCommitHashes } from '../utils/merge-queue';
 
 export class InitiateDeployment extends HelperInputs {
   sha = '';
@@ -31,7 +29,6 @@ export class InitiateDeployment extends HelperInputs {
 export const initiateDeployment = async ({
   sha,
   state = 'in_progress',
-  context = DEFAULT_PIPELINE_STATUS,
   environment,
   environment_url,
   description,
@@ -58,17 +55,5 @@ export const initiateDeployment = async ({
     ...GITHUB_OPTIONS
   });
 
-  const commitHashesForMergeQueueBranches = await getMergeQueueCommitHashes();
-  await map(commitHashesForMergeQueueBranches, async sha =>
-    octokit.repos.createCommitStatus({
-      sha,
-      context,
-      state: 'pending',
-      description,
-      target_url,
-      ...githubContext.repo
-    })
-  );
-
   return deployment_id;
 };

dist/index.js

@@ -11,7 +11,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { DEFAULT_PIPELINE_STATUS, GITHUB_OPTIONS } from '../../src/constants';
+import { GITHUB_OPTIONS } from '../../src/constants';
 import { Mocktokit } from '../types';
 import { context } from '@actions/github';
 import { initiateDeployment } from '../../src/helpers/initiate-deployment';
@@ -23,7 +23,6 @@ jest.mock('@actions/github', () => ({
   getOctokit: jest.fn(() => ({
     rest: {
       repos: {
-        createCommitStatus: jest.fn(),
         createDeployment: jest.fn(),
         createDeploymentStatus: jest.fn(),
         listBranches: jest.fn(() => ({ data: [] }))
@@ -81,92 +80,6 @@ describe('initiateDeployment', () => {
     });
   });
 
-  it('should call createCommitStatus with correct params', async () => {
-    await initiateDeployment({
-      sha,
-      environment,
-      description,
-      target_url
-    });
-    expect(octokit.repos.createCommitStatus).not.toHaveBeenCalledWith({
-      sha: 'normal sha 1',
-      context: DEFAULT_PIPELINE_STATUS,
-      state: 'pending',
-      description,
-      target_url,
-      ...context.repo
-    });
-    expect(octokit.repos.createCommitStatus).not.toHaveBeenCalledWith({
-      sha: 'merge queue sha 1',
-      context: DEFAULT_PIPELINE_STATUS,
-      state: 'pending',
-      description,
-      target_url,
-      ...context.repo
-    });
-    expect(octokit.repos.createCommitStatus).not.toHaveBeenCalledWith({
-      sha: 'merge queue sha 2',
-      context: DEFAULT_PIPELINE_STATUS,
-      state: 'pending',
-      description,
-      target_url,
-      ...context.repo
-    });
-  });
-
-  it('should call createCommitStatus with correct params when merge queue branches are present', async () => {
-    (octokit.repos.listBranches as unknown as Mocktokit).mockImplementation(async ({ page }) =>
-      page > 1
-        ? { data: [] }
-        : {
-            data: [
-              {
-                name: 'some-branch',
-                commit: { sha: 'normal sha 1' }
-              },
-              {
-                name: 'gh-readonly-queue/default-branch/pr-123-79a5ad2b1a46f6b5d77e02573937667979635f27',
-                commit: { sha: 'merge queue sha 1' }
-              },
-              {
-                name: 'gh-readonly-queue/default-branch/pr-456-79a5ad2b1a46f6b5d77e02573937667979635f27',
-                commit: { sha: 'merge queue sha 2' }
-              }
-            ]
-          }
-    );
-    await initiateDeployment({
-      sha,
-      environment,
-      description,
-      target_url
-    });
-    expect(octokit.repos.createCommitStatus).not.toHaveBeenCalledWith({
-      sha: 'normal sha 1',
-      context: DEFAULT_PIPELINE_STATUS,
-      state: 'pending',
-      description,
-      target_url,
-      ...context.repo
-    });
-    expect(octokit.repos.createCommitStatus).toHaveBeenCalledWith({
-      sha: 'merge queue sha 1',
-      context: DEFAULT_PIPELINE_STATUS,
-      state: 'pending',
-      description,
-      target_url,
-      ...context.repo
-    });
-    expect(octokit.repos.createCommitStatus).toHaveBeenCalledWith({
-      sha: 'merge queue sha 2',
-      context: DEFAULT_PIPELINE_STATUS,
-      state: 'pending',
-      description,
-      target_url,
-      ...context.repo
-    });
-  });
-
   it('should return deployment id as output', async () => {
     const result = await initiateDeployment({
       sha,

dist/index.js.map

@@ -33,6 +33,7 @@ jest.mock('../../src/helpers/is-user-in-team');
 jest.mock('../../src/helpers/approvals-satisfied');
 jest.mock('../../src/helpers/create-pr-comment');
 jest.mock('../../src/utils/../../src/helpers/prepare-queued-pr-for-merge');
+jest.mock('path');
 jest.mock('@actions/core');
 jest.mock('@actions/github', () => ({
   context: { repo: { repo: 'repo', owner: 'owner' }, issue: { number: 123 }, serverUrl: 'sampleUrl' },