GitHub Actions integration in Cypress

Introduction

GitHub Actions lets you run tasks automatically when you change your code. Integrating Cypress means you can test your website every time you update it, without doing it by hand.

You want to check your website works after every code change.

You want to run tests automatically when you push code to GitHub.

You want to catch bugs early before your users see them.

You want to save time by automating your testing process.

You want to share test results easily with your team.

Syntax

Cypress

name: Cypress Tests
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - run: npm install
      - run: npx cypress run

This is a basic GitHub Actions workflow file in YAML format.

It runs Cypress tests on every push or pull request automatically.

Examples

This runs tests whenever you push code to any branch.

Cypress

on: push
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: npm install
      - run: npx cypress run

This runs tests only on pull requests targeting the main branch, using clean install.

Cypress

on:
  pull_request:
    branches: [main]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: npm ci
      - run: npx cypress run

This example adds caching to speed up repeated installs.

Cypress

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Cache node modules
        uses: actions/cache@v3
        with:
          path: ~/.npm
          key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
      - run: npm ci
      - run: npx cypress run

Sample Program

This workflow runs Cypress tests on every push or pull request. It checks out the code, sets up Node.js version 18, installs dependencies cleanly, and runs Cypress tests.

Cypress

name: Cypress Tests
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - run: npm ci
      - run: npx cypress run

Important Notes

Make sure your project has a valid package.json with Cypress listed as a dependency.

You can customize the Node.js version in the setup step to match your project needs.

Check GitHub Actions logs to see detailed test results and errors if tests fail.

Summary

GitHub Actions can run Cypress tests automatically on code changes.

This helps catch bugs early and saves manual testing time.

Workflows are defined in YAML files inside your project's .github/workflows folder.

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