update github action scripts (#58)

Author: carmelc

.github/actions/run-playwright/action.yml

@@ -7,23 +7,107 @@ inputs:
   provider:
     description: 'Which next deployment provider is used'
     required: true
+  githubToken:
+    description: 'GitHub Token'
+    required: true
+  prNumber:
+    description: 'Pull request ID (optional)'
+    required: false
+outputs:
+  conclusion:
+    description: 'E2E result'
 runs:
   using: "composite"
   steps:
     - name: Run E2E Tests on Netlify URL
+      id: playwright-e2e
       run: REMOTE_PROVIDER=${{ inputs.provider }} yarn e2e
       shell: bash
       env:
         PLAYWRIGHT_TEST_BASE_URL: ${{ inputs.provider-deployment-url }}
     - uses: actions/upload-artifact@v3
+      id: playwright-report-artifact
       if: always()
       with:
         name: playwright-report-${{ inputs.provider }}
         path: playwright-report/
         retention-days: 10
     - uses: actions/upload-artifact@v3
+      id: playwright-screenshots-artifact
       if: always()
       with:
         name: screenshots-${{inputs.provider}}
         path: tests/e2e/__screenshots__/${{inputs.provider}}
         retention-days: 10
+    - uses: actions/github-script@v6
+      if: always()
+      with:
+        github-token: ${{ inputs.githubToken }}
+        script: |
+          const conclusion = '${{ steps.playwright-e2e.outcome }}';
+          const prNumber = '${{ inputs.prNumber }}';
+          const provider = '${{ inputs.provider }}';
+          const deploymentUrl = '${{ inputs.provider-deployment-url }}';
+          
+          if (prNumber && conclusion) {
+            core.setOutput('conclusion', conclusion);
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            const jobName = context.job;
+            const runId = context.runId;
+
+            const pullRequest = await github.rest.pulls.get({
+              owner,
+              repo,
+              pull_number: prNumber,
+            });
+            const checksForPr = await github.rest.checks.listForRef({
+              owner: owner,
+              repo: repo,
+              ref: pullRequest.data.head.ref,
+            });
+          
+            let checkRunId = null;
+            for (const checkRun of checksForPr.data.check_runs) {
+              if (checkRun.name === jobName) {
+                checkRunId = checkRun.id;
+                console.log(`Found Check Run ID: ${checkRunId}`);
+                break;
+              }
+            }
+          
+            if (checkRunId) {
+              const checkInput = {
+                owner,
+                repo,
+                check_run_id: checkRunId,
+                pull_request: prNumber,
+                status: 'completed',
+                conclusion: conclusion,
+                output: {
+                  title: `e2e ${provider}`,
+                  summary: `e2e ${provider}: ${conclusion}`,
+                },
+              };
+              github.rest.checks.update(checkInput).catch((error) => {
+                console.warn('Error updating check:', error, ' flow continues');
+              });
+            }
+            // Create a comment with the artifact links on the pull request
+            const artifactLinks = [
+              `## ${conclusion === 'success' ? ':green_circle:' : ':red_circle:'} Playwright E2E for ${provider.toUpperCase()}`,
+              `| Name | Info    |`,
+              `|------|---------|`,
+              `| Summary | [Action Summary](https://github.com/${owner}/${repo}/actions/runs/${runId}/) |`,
+              `| Site URL | [${deploymentUrl}](${deploymentUrl}) |`,
+            ];
+            const comment = artifactLinks.join('\n');
+            github.rest.issues.createComment({
+              owner,
+              repo,
+              issue_number: pullRequest.data.number,
+              body: comment
+            }).catch((error) => {
+              console.warn('Error creating comment:', error, ' flow continues');
+            });
+          }

.github/workflows/netlify-e2e.yml

@@ -2,26 +2,41 @@ name: Netlify E2E
 on:
   pull_request:
     branches: [ main ]
+  workflow_dispatch:
+    inputs:
+      deploymentUrl:
+        description: 'The deployment URL to test with'
+        required: true
+      prNumber:
+        description: 'Pull request number (optional)'
+        required: false
 jobs:
   netlify-e2e:
     timeout-minutes: 60
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: 'yarn'
-      - name: Install dependencies
-        run: yarn
-      - uses: ./.github/actions/setup-playwright
-      - name: Waiting for 200 from the Netlify Preview
-        uses: jakepartusch/wait-for-netlify-action@v1.4
-        id: waitFor200
-        with:
-          site_name: "wix-cms-nextjs-template" # TODO: change to your site name
-          max_timeout: 120 # 2 Minutes, depends on your build pipeline duration
-      - uses: ./.github/actions/run-playwright
-        with:
-          provider: 'netlify'
-          provider-deployment-url: ${{ steps.waitFor200.outputs.url }}
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16
+        cache: 'yarn'
+    - name: Install dependencies
+      run: yarn
+    - uses: ./.github/actions/setup-playwright
+    - name: Waiting for 200 from the Netlify Preview
+      if: ${{ !github.event.inputs.deploymentUrl }}
+      uses: jakepartusch/wait-for-netlify-action@v1.4
+      id: waitFor200
+      with:
+        site_name: "wix-cms-nextjs-template" # TODO: change to your site name
+        max_timeout: 120 # 2 Minutes, depends on your build pipeline duration
+    - name: Set Run with URL
+      run: |
+        echo "DEPLOYMENT_URL=${{ github.event.inputs.deploymentUrl || steps.waitFor200.outputs.url }}" >> $GITHUB_ENV
+    - uses: ./.github/actions/run-playwright
+      id: runPlaywright
+      with:
+        provider: 'netlify'
+        githubToken: ${{ secrets.GITHUB_TOKEN }}
+        prNumber: ${{ github.event.inputs.prNumber || github.event.pull_request.number }}
+        provider-deployment-url: ${{ env.DEPLOYMENT_URL }}

.github/workflows/vercel-e2e.yml

@@ -4,9 +4,17 @@
 name: Vercel E2E
 on:
   deployment_status:
+  workflow_dispatch:
+    inputs:
+      deploymentUrl:
+        description: 'The deployment URL to test with'
+        required: true
+      prNumber:
+        description: 'Pull request number (optional)'
+        required: false
 jobs:
   vercel-e2e:
-    if: github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success' && contains(github.event.deployment_status.target_url, 'vercel-demo-wix-cms') # TODO: change to your site name
+    if: github.event.inputs.deploymentUrl || (github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success' && contains(github.event.deployment_status.target_url, 'vercel-demo-wix-cms')) # TODO: change to your site name
     timeout-minutes: 60
     runs-on: ubuntu-latest
     steps:
@@ -18,7 +26,14 @@ jobs:
     - name: Install dependencies
       run: yarn
     - uses: ./.github/actions/setup-playwright
+    - name: Set Run with URL
+      run: |
+        echo "setting DEPLOYMENT_URL=${{ github.event.inputs.deploymentUrl || github.event.deployment_status.target_url }}"
+        echo "DEPLOYMENT_URL=${{ github.event.inputs.deploymentUrl || github.event.deployment_status.target_url }}" >> $GITHUB_ENV
     - uses: ./.github/actions/run-playwright
+      id: runPlaywright
       with:
         provider: 'vercel'
-        provider-deployment-url: ${{ github.event.deployment_status.target_url }}
+        githubToken: ${{ secrets.GITHUB_TOKEN }}
+        prNumber: ${{ github.event.inputs.prNumber }}
+        provider-deployment-url: ${{ env.DEPLOYMENT_URL }}

.gitignore

@@ -46,3 +46,9 @@ next-env.d.ts
 !.yarn/sdks
 !.yarn/versions
 .yarn/install-state.gz
+#IDEA
+.idea
+#Playwright
+/test-results/
+/playwright-report/
+/playwright/.cache/