GitHub Actions integration in Cypress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is GitHub Actions used for in a project?

GitHub Actions automates tasks like testing, building, and deploying code whenever you push changes. It helps keep your project working smoothly without manual steps.

beginner

How do you trigger a GitHub Action workflow?

You trigger a workflow by events like pushing code, opening a pull request, or on a schedule. These events tell GitHub Actions to start running the defined tasks.

intermediate

What is the purpose of the 'jobs' section in a GitHub Actions workflow file?

The 'jobs' section defines what tasks run and on which machine. Each job can have steps like installing dependencies, running tests, or deploying.

beginner

Why use Cypress with GitHub Actions?

Cypress runs automated tests for your web app. Using it with GitHub Actions lets you test your app automatically on every code change to catch problems early.

beginner

What file format and location does GitHub Actions use for workflows?

Workflows are YAML files stored in the '.github/workflows/' folder in your repository.

Where do you place GitHub Actions workflow files in your repository?

A .github/workflows/

B src/actions/

C workflows/

D actions/

Workflow files must be in the '.github/workflows/' directory for GitHub to detect and run them.

Which event can trigger a GitHub Actions workflow?

A push

B compile

C install

D run

The 'push' event triggers workflows when code is pushed to the repository.

What does a 'job' in GitHub Actions contain?

A User credentials

B Only code files

C A set of steps to run on a machine

D Database configurations

A job is a group of steps executed on a runner machine.

Why integrate Cypress tests in GitHub Actions?

A To manage user accounts

B To deploy apps faster

C To write code automatically

D To automatically test web apps on code changes

Cypress tests run automatically to check app quality whenever code changes.

Which file format is used for GitHub Actions workflows?

A JSON

B YAML

C XML

D TXT

GitHub Actions workflows are written in YAML format.

Explain how to set up a basic GitHub Actions workflow to run Cypress tests on every push.

Think about the file location, event trigger, and commands to run tests.

Describe the benefits of using GitHub Actions with Cypress for a web project.

Focus on automation and quality assurance.

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