Merge pull request #1102 from chromaui/cody/ci-cd-test

Setup workflow for PR checks

.github/workflows/chromatic-prod.yml

@@ -1,5 +1,10 @@
 name: Chromatic
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read

.github/workflows/lint-and-test.yml

@@ -1,5 +1,10 @@
 name: Lint and Test
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      CODACY_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read

.github/workflows/package-size.yml

@@ -1,8 +1,12 @@
 name: Chromatic Package Size
+
 on:
-  pull_request:
-    branches: [main]
-    types: [opened, synchronize]
+  workflow_call:
+    secrets:
+      UPSTASH_REDIS_REST_URL:
+        required: true
+      UPSTASH_API_KEY:
+        required: true
 
 permissions:
   contents: read

.github/workflows/pull-request-workflow.yml

@@ -0,0 +1,96 @@
+name: Test PR
+
+on:
+  merge_group:
+    types:
+     - checks_requested
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+permissions:
+  contents: read
+
+jobs:
+  package-size:
+    uses: ./.github/workflows/package-size.yml
+    permissions:
+      contents: read
+      issues: write
+      pull-requests: write
+    secrets:
+      UPSTASH_REDIS_REST_URL: ${{ secrets.UPSTASH_REDIS_REST_URL }}
+      UPSTASH_API_KEY: ${{ secrets.UPSTASH_API_KEY }}
+
+  lint-and-test:
+    uses: ./.github/workflows/lint-and-test.yml
+    secrets:
+      CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+
+  chromatic:
+    uses: ./.github/workflows/chromatic-prod.yml
+    needs: lint-and-test
+    secrets:
+      CHROMATIC_PROJECT_TOKEN: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-action:
+    uses: ./.github/workflows/smoke-test-action.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-node-api:
+    uses: ./.github/workflows/smoke-test-node-api.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-node-18:
+    uses: ./.github/workflows/smoke-test-node18.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-node-20:
+    uses: ./.github/workflows/smoke-test-node20.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-npx:
+    uses: ./.github/workflows/smoke-test-npx.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-windows:
+    uses: ./.github/workflows/smoke-test-windows.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-yarn:
+    uses: ./.github/workflows/smoke-test-yarn.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-yarn-berry:
+    uses: ./.github/workflows/smoke-test-yarn-berry.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-yarn-canary:
+    uses: ./.github/workflows/smoke-test-yarn-canary.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}
+
+  smoke-test-yarn-classic:
+    uses: ./.github/workflows/smoke-test-yarn-classic.yml
+    needs: lint-and-test
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN: ${{ secrets.SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN }}

.github/workflows/smoke-test-action.yml

@@ -1,5 +1,9 @@
 name: Smoke test via action
-on: push
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read

.github/workflows/smoke-test-node-api.yml

@@ -1,5 +1,10 @@
 name: Smoke test via node api
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read

.github/workflows/smoke-test-node18.yml

@@ -1,5 +1,10 @@
 name: Smoke test via Node 18
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read

.github/workflows/smoke-test-node20.yml

@@ -1,5 +1,10 @@
 name: Smoke test via Node 20
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read

.github/workflows/smoke-test-npx.yml

@@ -1,11 +1,16 @@
 name: Smoke test via npx
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read
 
 jobs:
-  chromatic:
+  self-test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/smoke-test-windows.yml

@@ -1,11 +1,16 @@
 name: Smoke test via yarn on Windows
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read
 
 jobs:
-  chromatic:
+  self-test:
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/smoke-test-yarn-berry.yml

@@ -1,11 +1,16 @@
 name: Smoke test via yarn berry
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read
 
 jobs:
-  chromatic:
+  self-test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/smoke-test-yarn-canary.yml

@@ -1,11 +1,16 @@
 name: Smoke test via yarn canary
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read
 
 jobs:
-  chromatic:
+  self-test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/smoke-test-yarn-classic.yml

@@ -1,11 +1,16 @@
 name: Smoke test via yarn classic
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read
 
 jobs:
-  chromatic:
+  self-test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/smoke-test-yarn.yml

@@ -1,5 +1,10 @@
 name: Smoke test via yarn
-on: push
+
+on:
+  workflow_call:
+    secrets:
+      SMOKE_TESTS_CHROMATIC_PROJECT_TOKEN:
+        required: true
 
 permissions:
   contents: read

node-src/git/getCommitAndBranch.test.ts

@@ -50,6 +50,8 @@ const commitInfo = {
 
 describe('getCommitAndBranch', () => {
   it('returns commit and branch info', async () => {
+    process.env.GITHUB_EVENT_NAME = 'push';
+
     const info = await getCommitAndBranch(ctx);
     expect(info).toMatchObject({
       branch: 'main',
@@ -62,6 +64,8 @@ describe('getCommitAndBranch', () => {
   });
 
   it('retrieves CI context', async () => {
+    process.env.GITHUB_EVENT_NAME = 'push';
+
     envCi.mockReturnValue({
       isCi: true,
       service: 'ci-service',
@@ -84,6 +88,8 @@ describe('getCommitAndBranch', () => {
   });
 
   it('prefers prBranch over ciBranch', async () => {
+    process.env.GITHUB_EVENT_NAME = 'push';
+
     envCi.mockReturnValue({
       branch: 'ci-branch',
       prBranch: 'ci-pr-branch',
@@ -94,9 +100,11 @@ describe('getCommitAndBranch', () => {
   });
 
   it('removes origin/ prefix in branch name', async () => {
-    getBranch.mockResolvedValue('origin/master');
+    process.env.GITHUB_EVENT_NAME = 'push';
+
+    getBranch.mockResolvedValue('origin/main');
     const info = await getCommitAndBranch(ctx);
-    expect(info).toMatchObject({ branch: 'master' });
+    expect(info).toMatchObject({ branch: 'main' });
   });
 
   it('throws when there is only one commit, CI', async () => {
@@ -114,23 +122,31 @@ describe('getCommitAndBranch', () => {
 
   describe('with branchName', () => {
     it('uses provided branchName as branch', async () => {
+      process.env.GITHUB_EVENT_NAME = 'push';
+
       const info = await getCommitAndBranch(ctx, { branchName: 'foobar' });
       expect(info).toMatchObject({ branch: 'foobar' });
     });
 
     it('does not remove origin/ prefix in branch name', async () => {
+      process.env.GITHUB_EVENT_NAME = 'push';
+
       const info = await getCommitAndBranch(ctx, { branchName: 'origin/foobar' });
       expect(info).toMatchObject({ branch: 'origin/foobar' });
     });
   });
 
   describe('with patchBaseRef', () => {
     it('uses provided patchBaseRef as branch', async () => {
+      process.env.GITHUB_EVENT_NAME = 'push';
+
       const info = await getCommitAndBranch(ctx, { patchBaseRef: 'foobar' });
       expect(info).toMatchObject({ branch: 'foobar' });
     });
 
     it('prefers branchName over patchBaseRef', async () => {
+      process.env.GITHUB_EVENT_NAME = 'push';
+
       const info = await getCommitAndBranch(ctx, { branchName: 'foo', patchBaseRef: 'bar' });
       expect(info).toMatchObject({ branch: 'foo' });
     });