example-debug.yml

name: example-debug

# This workflow demonstrates how to use the DEBUG environment variable to get debug output.
# See also https://github.com/cypress-io/github-action/blob/master/README.md#debugging and
# https://on.cypress.io/troubleshooting#Print-DEBUG-logs

# In the example jobs, the action is called with
# uses: ./
# which runs the action code from the current branch.
# If you copy this workflow to another repo, replace the above line with
# uses: cypress-io/github-action@v6

on:
  push:
    branches:
      - 'master'
  pull_request:
  workflow_dispatch:

jobs:
  action-debug:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Cypress action debug logs
        uses: ./
        env:
          # This enables debug logging output for the action
          DEBUG: '@cypress/github-action'
        with:
          working-directory: examples/basic

  cypress-debug:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Cypress debug logs
        uses: ./
        env:
          # This enables debug logging output for Cypress
          # See https://on.cypress.io/troubleshooting#Log-sources for other filtered DEBUG values
          DEBUG: 'cypress:*'
        with:
          working-directory: examples/basic

        # You can also combine the two debug options into one line
        # to get both action debug and Cypress debug output
        # DEBUG: '@cypress/github-action, cypress:*'

  install-binary-debug:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Cypress npm install
        # Install only the Cypress npm module
        uses: ./
        with:
          working-directory: examples/basic
          runTests: false
        env:
          # Skip the Cypress binary installation
          CYPRESS_INSTALL_BINARY: 0

      - name: Cypress binary install
        # Now install the Cypress binary with debug enabled
        uses: ./
        with:
          working-directory: examples/basic
          # use --force option to override any cached Cypress binary version
          command: npx cypress install --force
        env:
          DEBUG: 'cypress:cli*'