github-action VS knapsack-pro-cypress

# .github/workflows/main.yml name: cypress-crud-api-test on: push: workflow_dispatch: # if this branch is pushed back to back, cancel the older branch's workflow concurrency: group: ${{ github.ref }} && ${{ github.workflow }} cancel-in-progress: true jobs: test: strategy: # uses 1 CI machine matrix: machines: [1] runs-on: ubuntu-20.04 steps: - name: Checkout 🛎 uses: actions/checkout@v2 # https://github.com/cypress-io/github-action - name: Run api tests 🧪 uses: cypress-io/[email protected] with: browser: chrome record: true group: crud api test env: CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }} LAUNCH_DARKLY_PROJECT_KEY: ${{ secrets.LAUNCH_DARKLY_PROJECT_KEY }} LAUNCH_DARKLY_AUTH_TOKEN: ${{ secrets.LAUNCH_DARKLY_AUTH_TOKEN }} LAUNCHDARKLY_SDK_KEY: ${{ secrets.LAUNCHDARKLY_SDK_KEY }} #{{ # Here we are running the unit tests after the e2e # taking advantage of npm install in Cypress GHA. # Ideally we install first, and carry over the cache # to unit and e2e jobs. # Check this link for the better way: # https://github.com/muratkeremozcan/react-hooks-in-action-with-cypress/blob/main/.github/workflows/main.yml - name: run unit tests run: npm run test

For much more info regarding the Cypress Github Action, check out their detailed documentation. I'm just barely scratching the surface of its capabilities here.

Cypress maintains a very neat GitHub Action that makes CI usage convenient with custom parameters.

image: cypress/base:10 options: max-time: 30 # job definition for running E2E tests in parallel with KnapsackPro.com e2e: &e2e name: Run E2E tests with @knapsack-pro/cypress caches: - node - cypress script: # run web application in the background - npm run start:ci & # env vars from https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/ - export KNAPSACK_PRO_CI_NODE_BUILD_ID=$BITBUCKET_BUILD_NUMBER - export KNAPSACK_PRO_COMMIT_HASH=$BITBUCKET_COMMIT - export KNAPSACK_PRO_BRANCH=$BITBUCKET_BRANCH - export KNAPSACK_PRO_CI_NODE_TOTAL=$BITBUCKET_PARALLEL_STEP - export KNAPSACK_PRO_CI_NODE_INDEX=$BITBUCKET_PARALLEL_STEP_COUNT # https://github.com/KnapsackPro/knapsack-pro-cypress#configuration-steps - export KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true - $(npm bin)/knapsack-pro-cypress artifacts: # store any generated images and videos as artifacts - cypress/screenshots/** - cypress/videos/** pipelines: default: - step: name: Install dependencies caches: - npm - cypress - node script: - npm ci - parallel: # run N steps in parallel - step: <<: *e2e - step: <<: *e2e - step: <<: *e2e definitions: caches: npm: $HOME/.npm cypress: $HOME/.cache/Cypress