feat: cicd e2e label requirements + pr automation (#12243)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

This PR does a few things
1. Automatically set new PRs targeting main to "draft" state.
2. Enforce the E2E Bitrise Status Check on lifecycle on incoming PRs
which will essentially enforce that the PR has 1 of the two labels 'Run
Smoke E2E' or 'No E2E Smoke Needed'


<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
4. What is the improvement/solution?
-->

With this change we're looking to improve the posture on our PR
lifecycle with auto drafts and enforce a higher standard for incoming
changes towards or E2E testing posture.

## **Related issues**

[Fixes:]

#11747

## **Manual testing steps**

UC1 : Nether E2E Label is set
->
https://github.com/MetaMask/metamask-mobile/actions/runs/11826040868/job/32951145968?pr=12243
    Expected : Not Mergeable

UC2 : docs PR

Should run: false, Reason: The pull request is documentation related.
Skipping Bitrise status check. due to the following reason: The pull
request is documentation related.
Created 'Bitrise E2E Status' check with skipped status for commit
dea08a9

https://github.com/MetaMask/metamask-mobile/actions/runs/11826187817/job/32951608300?pr=12243

Expected: Mergeable

UC3 : No E2E Smoke Needed Label is set

Anti label: true
Should run: false, Reason: The pull request has the anti-label.
Skipping Bitrise status check. due to the following reason: The pull
request has the anti-label.
Created 'Bitrise E2E Status' check with skipped status for commit
dea08a9[22]

https://github.com/MetaMask/metamask-mobile/actions/runs/11826234735/job/32951749305?pr=12243

Expected Mergeable


UC4: Smoke E2E Label is set

Should run: true, Reason: The smoke test label is present.
Starting Bitrise build for commit
dea08a9


## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

N/A CICD Changes only

### **After**

<!-- [screenshots/recordings] -->

N/A CICD Changes only

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [x] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [x] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

---------

Co-authored-by: Cal Leung <cal.leung@consensys.net>

.github/scripts/bitrise/run-bitrise-e2e-check.ts

@@ -13,9 +13,33 @@ main().catch((error: Error): void => {
   process.exit(1);
 });
 
+// Determine whether E2E should run and provide the associated reason
+function shouldRunBitriseE2E(antiLabel: boolean, hasSmokeTestLabel: boolean, isDocs: boolean, isFork: boolean, isMergeQueue: boolean): [boolean, string] {
+
+  const conditions = [
+    {condition: hasSmokeTestLabel, message: "The smoke test label is present.", shouldRun: true},
+    {condition: isFork, message: "The pull request is from a fork.", shouldRun: false},
+    {condition: isDocs, message: "The pull request is documentation related.", shouldRun: false},
+    {condition: isMergeQueue, message: "The pull request is part of a merge queue.", shouldRun: false},
+    {condition: antiLabel, message: "The pull request has the anti-label.", shouldRun: false}
+  ];
+
+  // Iterate through conditions to determine action
+  for (const {condition, message, shouldRun} of conditions) {
+    if (condition) {
+      return [shouldRun, message];
+    }
+  }
+
+  // Default case if no conditions met
+  return [false, "Unexpected scenario or no relevant labels found."];
+}
+
+
 async function main(): Promise<void> {
   const githubToken = process.env.GITHUB_TOKEN;
   const e2eLabel = process.env.E2E_LABEL;
+  const antiLabel = process.env.NO_E2E_LABEL;
   const e2ePipeline = process.env.E2E_PIPELINE;
   const workflowName = process.env.WORKFLOW_NAME;
   const triggerAction = context.payload.action as PullRequestTriggerType;
@@ -42,6 +66,17 @@ async function main(): Promise<void> {
     process.exit(1);
   }
 
+  if (!antiLabel) {
+    core.setFailed('NO_E2E_LABEL not found');
+    process.exit(1);
+  }
+
+  // Logging for Pipeline debugging
+  console.log(`Trigger action: ${triggerAction}`);
+  console.log(`event: ${context.eventName}`);
+  console.log(`pullRequestNumber: ${pullRequestNumber}`);
+
+
   const octokit: InstanceType<typeof GitHub> = getOctokit(githubToken);
 
   const { data: prData } = await octokit.rest.pulls.get({
@@ -50,30 +85,55 @@ async function main(): Promise<void> {
     pull_number: pullRequestNumber,
   });
 
+  const docs = prData.title.startsWith("docs:");
+
   // Get the latest commit hash
   const latestCommitHash = prData.head.sha;
 
-  // Check if the e2e smoke label is applied
+  // Grab flags and labels
   const labels = prData.labels;
   const hasSmokeTestLabel = labels.some((label) => label.name === e2eLabel);
+  const hasAntiLabel = labels.some((label) => label.name === antiLabel);
+  const fork = context.payload.pull_request?.head.repo.fork || false;
+  const mergeQueue = (context.eventName === 'merge_group')
+
+
+  console.log(`Docs: ${docs}`);
+  console.log(`Fork: ${fork}`);
+  console.log(`Merge Queue: ${mergeQueue}`);
+  console.log(`Has smoke test label: ${hasSmokeTestLabel}`);
+  console.log(`Anti label: ${hasAntiLabel}`);
 
-  // Pass check since e2e smoke label is not applied
-  if (!hasSmokeTestLabel) {
+
+  // One of these two labels must exist if not we bomb out
+  if (!hasSmokeTestLabel && !hasAntiLabel) {
+    core.setFailed(
+      `At least 1 E2E Label must be Applied either ${e2eLabel} or ${antiLabel}`,
+    );
+    process.exit(1);
+  }
+
+  const [shouldRun, reason] = shouldRunBitriseE2E(hasAntiLabel, hasSmokeTestLabel, docs, fork, mergeQueue);
+  console.log(`Should run: ${shouldRun}, Reason: ${reason}`);
+
+
+  if (!shouldRun) {
     console.log(
-      `"${e2eLabel}" label not applied. Skipping Bitrise status check.`,
+      `Skipping Bitrise status check. due to the following reason: ${reason}`,
     );
+
     // Post success status (skipped)
     const createStatusCheckResponse = await octokit.rest.checks.create({
       owner,
       repo,
       name: statusCheckName,
       head_sha: latestCommitHash,
       status: StatusCheckStatusType.Completed,
-      conclusion: CompletedConclusionType.Success,
+      conclusion: CompletedConclusionType.Success, 
       started_at: new Date().toISOString(),
       output: {
         title: statusCheckTitle,
-        summary: 'Skip run since no E2E smoke label is applied',
+        summary: `Skip run since ${reason}`,
       },
     });
 
@@ -95,6 +155,8 @@ async function main(): Promise<void> {
     triggerAction === PullRequestTriggerType.Labeled &&
     context.payload?.label?.name === e2eLabel
   ) {
+
+    console.log(`Starting Bitrise build for commit ${latestCommitHash}`);
     // Configure Bitrise configuration for API call
     const data = {
       build_params: {
@@ -222,6 +284,8 @@ async function main(): Promise<void> {
     }
 
     // Post pending status
+    console.log(`Posting pending status for commit ${latestCommitHash}`);
+
     const createStatusCheckResponse = await octokit.rest.checks.create({
       owner,
       repo,
@@ -256,6 +320,8 @@ async function main(): Promise<void> {
   const lastCommentPage = Math.ceil(
     numberOfTotalComments / numberOfCommentsToCheck,
   );
+
+
   const { data: latestCommentBatch } = await octokit.rest.issues.listComments({
     owner,
     repo,
@@ -287,6 +353,8 @@ async function main(): Promise<void> {
 
   // Bitrise comment doesn't exist, post fail status
   if (!bitriseComment) {
+
+    console.log(`Bitrise comment not detected for commit ${latestCommitHash}`);
     // Post fail status
     const createStatusCheckResponse = await octokit.rest.checks.create({
       owner,

.github/workflows/auto-draft-prs.yml

@@ -0,0 +1,39 @@
+name: Auto Draft
+
+on:
+  pull_request:
+    types: [opened]
+    branches:
+    - main
+
+permissions:
+    pull-requests: write
+    contents: read
+    issues: write
+
+jobs:
+  process_pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Convert PR to Draft and Add Label
+        uses: actions/github-script@v6
+        with:
+          script: |
+            // Convert PR to draft
+            await github.rest.pulls.update({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.payload.pull_request.number,
+              draft: true
+            });
+
+            // Check if the PR title includes "docs:" or if it's from a fork
+            if (context.payload.pull_request.title.includes('docs:') || context.payload.pull_request.head.repo.fork) {
+              // Add label "No E2E Smoke Needed"
+              await github.rest.issues.addLabels({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.payload.pull_request.number,
+                labels: ['No E2E Smoke Needed']
+              });
+            }

.github/workflows/ci.yml

@@ -323,4 +323,4 @@ jobs:
           else
             echo "All jobs passed step skipped. Block PR."
             exit 1
-          fi
+          fi

.github/workflows/run-bitrise-e2e-check.yml

@@ -5,32 +5,18 @@ on:
     types: [edited, deleted]
   pull_request:
     types: [opened, reopened, labeled, unlabeled, synchronize]
+  merge_group: # Trigger on merge queue events to satisfy the branch protection rules
+    types: [checks_requested]
 
 env:
   E2E_LABEL: 'Run Smoke E2E'
+  NO_E2E_LABEL: 'No E2E Smoke Needed'
   E2E_PIPELINE: 'pr_smoke_e2e_pipeline'
   WORKFLOW_NAME: 'run-bitrise-e2e-check'
 
 jobs:
-  is-fork-pull-request:
-    name: Determine pull request source
-    if: ${{ github.event.issue.pull_request || github.event_name == 'pull_request' }}
-    runs-on: ubuntu-latest
-    outputs:
-      IS_FORK: ${{ steps.is-fork.outputs.IS_FORK }}
-    steps:
-      - uses: actions/checkout@v3
-      - name: Determine whether this PR is from a fork
-        id: is-fork
-        run: echo "IS_FORK=$(gh pr view --json isCrossRepository --jq '.isCrossRepository' "${PR_NUMBER}" )" >> "$GITHUB_OUTPUT"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          PR_NUMBER: ${{ github.event.number || github.event.issue.number }}
-
   run-bitrise-e2e-check:
-    needs: is-fork-pull-request
     runs-on: ubuntu-latest
-    if: ${{ needs.is-fork-pull-request.outputs.IS_FORK == 'false' }}
     permissions:
       pull-requests: write
       contents: write