GitHub

​

Overview

​

What you get

​

Setup

1

Go to Integrations

Open the Integrations page in your Spur dashboard and connect GitHub.

Open Spur Integrations

Connect Spur with GitHub to get started

2

Open GitHub settings

Once connected, find GitHub on the integrations page and click Settings.

3

Configure your integration

The GitHub Integration Settings page has four sections. Review each one before proceeding.

API key

Your unique Spur API key is displayed here. This is what authenticates your GitHub repository with Spur. Copy it if you need to reference it manually.

Directory path

The path where your GitHub Actions workflow files will be stored. The default is .github/workflows — leave this as is unless your repository uses a custom structure.

Enabled test plans

Select which test plans should run as part of your CI/CD pipeline. Click + Add Test Plan to include additional ones.

YAML files

Two workflow files are generated for you here. You will download and add these to your repository in the next step.

Other integrations: You can also allow other integrations to be enabled for GitHub jobs.

4

Add the YAML files to your repository

Download both YAML files from the settings page and add them to your repository under .github/workflows/.

These two files are what make the integration work. Without them in your repository, Spur will not trigger on pull requests and no quality gate will be in place. Do not skip this step.

• Report Generation — generates and publishes test reports after each run
• Test Plan Trigger — tells GitHub when to trigger a Spur test plan run

5

Save changes

Click Save Changes to finalize your integration. From this point, Spur will run your selected test plans automatically on every pull request.

​

How the workflow files work

​

Test plan trigger

​

Report generation

1. Collects all Spur-related commit statuses for the PR
2. Generates a markdown report table with pass, fail, pending, and error counts for each test plan
3. Creates or updates a single PR comment (identified by a ## Spur CI/CD Report header) so your PR stays clean
4. Sets a summary commit status called CICD - All tests that reflects the overall result

​

Using the summary status for branch protection

1. Go to your repository’s Settings > Branches > Branch protection rules
2. Enable Require status checks to pass before merging
3. Search for and select CICD - All tests

​

Testing deploy previews

- name: Run Spur Tests
  run: |
    curl -X POST \
      -H "Content-Type: application/json" \
      -H "SPUR_GITHUB_KEY: ${{ secrets.SPUR_API_KEY }}" \
      -d "{\"override_urls\": {\"default\": \"${{ steps.deploy.outputs.preview_url }}\"}}" \
      "https://app.spurtest.com/api/webhook"