Giter Club home page Giter Club logo

cypress-tests's Introduction

Cypress with Github Actions - Simple setup guide

1. Prerequisites

  • NodeJS on your machine
  • A Github repo to run the actions in

2. Setup

  1. Install Cypress
    • Open the repo locally and in it run npm init() with default settings
    • Run npm install cypress --save-dev to install cypress in node project
    • You can now run npx cypress open to open the local tool (useful for writing and debugging tests)
  2. Write a Test Spec and Push everything except node_modules, cypress/videos, cypress/screenshots
  3. Create a GitHub Action using the Simple workflow template
    • Add the following code to the *.yml:
name: Cypress Tests using Cypress Docker Image
on: [push]
jobs:
  cypress-run:
    runs-on: ubuntu-latest
    container: cypress/browsers:node12.18.3-chrome87-ff82
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Cypress run
        uses: cypress-io/github-action@v2
        with:
          # Specify Browser since container image is compile with Firefox
          browser: chrome
          record: true
        env:
          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  1. Login to the Cypress Dashboard and follow the steps to get your Record Key
  2. Create a GitHub Secret named CYPRESS_RECORD_KEY
  3. Add the ProjectID from the Cypress Dashboard to cypress.json

3. Done

Now you should see the GitHub action running the tests on every push to the repo and in the Dashboard you can checkout the results + videos/screenshots and analytics

cypress-tests's People

Contributors

fluctuationqt avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.