GitHub Actions integration in Cypress - Build an Automation Script

Run Cypress tests automatically using GitHub Actions

Preconditions (2)

Step 1: Create a .github/workflows directory in the repository root

Step 2: Add a workflow YAML file named cypress-tests.yml inside .github/workflows

Step 3: Configure the workflow to trigger on push and pull request events

Step 4: Set up the job to run on the latest Ubuntu runner

Step 5: Install Node.js using actions/setup-node

Step 6: Install project dependencies using npm install

Step 7: Run Cypress tests using npx cypress run

Step 8: Verify the workflow completes successfully in GitHub Actions

✅ Expected Result: GitHub Actions workflow runs Cypress tests automatically on each push or pull request and reports success or failure in the Actions tab

Automation Requirements - cypress

Assertions Needed:

Verify the GitHub Actions workflow file exists and is valid YAML

Verify the workflow triggers on push and pull request

Verify the Cypress tests run and pass in the workflow logs

Best Practices:

Use explicit steps for setup, install, and test

Use official GitHub Actions like actions/setup-node

Keep workflow YAML clean and readable

Use caching for node_modules if possible to speed up runs

Automated Solution

Cypress

name: Cypress Tests

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  cypress-run:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - name: Install dependencies
        run: npm install

      - name: Run Cypress tests
        run: npx cypress run

This GitHub Actions workflow is named Cypress Tests. It triggers on push and pull_request events targeting the main branch.

The job cypress-run runs on the latest Ubuntu runner.

Steps include:

• Checkout repository: Uses actions/checkout@v3 to get the code.
• Setup Node.js: Uses actions/setup-node@v3 to install Node.js version 18.
• Install dependencies: Runs npm install to install project packages.
• Run Cypress tests: Runs npx cypress run to execute tests.

This setup ensures tests run automatically on GitHub servers whenever code changes are pushed or pull requests are created, providing quick feedback on test results.

Common Mistakes - 4 Pitfalls

{'mistake': 'Not specifying the Node.js version in setup-node action', 'why_bad': 'Without specifying the version, the workflow may use an unexpected Node.js version causing test failures.', 'correct_approach': "Always specify a stable Node.js version like '18' in the setup-node action."}

{'mistake': 'Running Cypress tests without installing dependencies first', 'why_bad': 'Tests will fail because Cypress and other packages are not installed.', 'correct_approach': "Run 'npm install' before running Cypress tests."}

{'mistake': 'Not triggering workflow on pull requests', 'why_bad': "Tests won't run on pull requests, missing early feedback on code changes.", 'correct_approach': 'Configure workflow triggers for both push and pull_request events.'}

{'mistake': 'Hardcoding branch names without considering main branch name', 'why_bad': "If the default branch is named differently, workflow won't trigger.", 'correct_approach': 'Use the correct default branch name or configure triggers accordingly.'}

Bonus Challenge

Now add caching for node_modules to speed up workflow runs

Show Hint

Practice

1. What is the main purpose of integrating Cypress tests with GitHub Actions?

easy

A. To manually trigger tests only when needed

B. To automatically run tests on code changes and catch bugs early

C. To deploy the application to production

D. To write Cypress test scripts inside GitHub

Solution

1. Step 1: Understand GitHub Actions role

   GitHub Actions automates tasks like running tests when code changes.

2. Step 2: Connect Cypress testing purpose

   Cypress tests run automatically to find bugs early without manual effort.

3. Final Answer:

   To automatically run tests on code changes and catch bugs early -> Option B

4. Quick Check:

   Automation of tests = A [OK]

Hint: GitHub Actions automates tasks on code changes [OK]

Common Mistakes:

• Thinking GitHub Actions only deploys code
• Believing tests run manually only
• Confusing test writing with test running

2. Which YAML key is used to specify the event that triggers a GitHub Actions workflow for Cypress tests?

easy

A. jobs

B. run

C. steps

D. on

Solution

1. Step 1: Identify trigger key in GitHub Actions YAML

   The on key defines events like push or pull_request that start the workflow.

2. Step 2: Differentiate from other keys

   run is used inside steps, steps lists commands, jobs groups tasks.

3. Final Answer:

   on -> Option D

4. Quick Check:

   Trigger event key = on [OK]

Hint: Triggers use 'on' key in GitHub Actions YAML [OK]

Common Mistakes:

• Confusing 'run' with trigger event
• Mixing 'steps' with event triggers
• Using 'jobs' as trigger key

3. Given this GitHub Actions snippet, what will happen when code is pushed to the main branch?

on:
  push:
    branches:
      - main
jobs:
  cypress-run:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run Cypress tests
        run: npx cypress run

medium

A. Cypress tests run automatically on push to main branch

B. Tests run only if manually triggered

C. Workflow fails due to missing trigger

D. Tests run on every branch push

Solution

1. Step 1: Analyze trigger event

   The workflow triggers on push to the main branch only.

2. Step 2: Understand job steps

   It checks out code and runs Cypress tests with npx cypress run.

3. Final Answer:

   Cypress tests run automatically on push to main branch -> Option A

4. Quick Check:

   Push to main triggers tests = C [OK]

Hint: Push to main triggers workflow with Cypress run [OK]

Common Mistakes:

• Assuming manual trigger needed
• Thinking tests run on all branches
• Believing workflow lacks trigger

4. You wrote this GitHub Actions workflow but Cypress tests never run:

on:
  push:
    branches:
      - main
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      - name: Run tests
        run: cypress run

What is the most likely error?

medium

A. Missing 'npx' before 'cypress run' command

B. Wrong branch name under 'push' event

C. Missing 'uses' for Cypress action

D. Incorrect 'runs-on' value

Solution

1. Step 1: Check Cypress run command syntax

   The command should be npx cypress run to run Cypress installed locally.

2. Step 2: Verify other parts

   Branch name 'main' is correct, 'runs-on' is valid, and Cypress action is optional if using CLI.

3. Final Answer:

   Missing 'npx' before 'cypress run' command -> Option A

4. Quick Check:

   Run command needs 'npx' prefix = B [OK]

Hint: Use 'npx cypress run' to execute tests in GitHub Actions [OK]

Common Mistakes:

• Running 'cypress run' without 'npx'
• Changing branch name incorrectly
• Expecting Cypress action is mandatory
• Misconfiguring runner OS

5. You want to run Cypress tests on both push and pull request events but only for the 'develop' branch. Which YAML snippet correctly configures this?

hard

A. on:
push:
branches:
- main
pull_request:
branches:
- main

B. on:
push:
branches:
- main
pull_request:
branches:
- develop

C. on:
push:
branches:
- develop
pull_request:
branches:
- develop

D. on:
push:
branches:
- develop
pull_request:
branches:
- main

Solution

1. Step 1: Identify required events and branches

   Tests must run on both push and pull_request events targeting the 'develop' branch only.

2. Step 2: Match YAML configuration

   on: push: branches: - develop pull_request: branches: - develop correctly lists both events with 'develop' branch under each.

3. Final Answer:

   on: push: branches: - develop pull_request: branches: - develop -> Option C

4. Quick Check:

   Both events on 'develop' branch = D [OK]

Hint: List both events with same branch under 'on' key [OK]

Common Mistakes:

• Mixing branch names between events
• Listing only one event
• Using wrong branch name