Bugster.dev GitHub Action

Trigger Bugster workflow executions from your GitHub Actions pipelines.

Usage

name: Bugster QA

on:
  push:
    branches: [main]

jobs:
  bugster:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Bugster QA
        uses: Bugsterapp/bugster-action@v2
        with:
          bugster_api_key: ${{ secrets.BUGSTER_API_KEY }}
          organization_id: "org_abc123"
          project_id: "my-project-1234567890"
          workflow_id: "wf_xyz789"

The action automatically detects the commit SHA and branch from the GitHub context — no need to pass them manually. The workflow_id determines which test suite, environment, and report channels to use (configured in the Bugster dashboard).

---

Inputs

Name	Required	Default	Description
bugster_api_key	Yes	—	API key for Bugster Cloud. Store as secrets.BUGSTER_API_KEY.
organization_id	Yes	—	Bugster organization ID.
project_id	Yes	—	Bugster project ID.
workflow_id	Yes	—	Bugster workflow ID. Determines which suite, environment, and reports to use.
deployment_state	No	success	One of in_progress, success, cancelled, failed, error. Invalid values fall back to success.
commit_sha	No	Auto-detected	Commit SHA. Auto-filled from GITHUB_SHA (or PR head SHA for pull_request events).
branch	No	Auto-detected	Branch name. Auto-filled from GITHUB_REF_NAME (or PR head ref for pull_request events).
api_base_url	No	https://api.bugster.app	Base API URL (for testing or self-hosted).
timeout_seconds	No	60	Request timeout in seconds.

---

Outputs

Name	Description
status	HTTP status code returned by the API.
response	Response body returned by the API (truncated).

---

Examples

Run on pull request (recommended)

name: Bugster QA

on:
  pull_request:
    branches: [main]

jobs:
  bugster:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Bugster QA
        uses: Bugsterapp/bugster-action@v2
        with:
          bugster_api_key: ${{ secrets.BUGSTER_API_KEY }}
          organization_id: "org_abc123"
          project_id: "my-project-1234567890"
          workflow_id: "wf_xyz789"

Bugster will automatically pick up the PR's head commit and branch, enabling GitHub Check Runs and PR comments.

Run on push to main

name: Bugster QA

on:
  push:
    branches: [main]

jobs:
  bugster:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Bugster QA
        uses: Bugsterapp/bugster-action@v2
        with:
          bugster_api_key: ${{ secrets.BUGSTER_API_KEY }}
          organization_id: "org_abc123"
          project_id: "my-project-1234567890"
          workflow_id: "wf_xyz789"

Manual dispatch

name: Bugster QA

on:
  workflow_dispatch:

jobs:
  bugster:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Bugster QA
        uses: Bugsterapp/bugster-action@v2
        with:
          bugster_api_key: ${{ secrets.BUGSTER_API_KEY }}
          organization_id: "org_abc123"
          project_id: "my-project-1234567890"
          workflow_id: "wf_xyz789"

---

How it works

1. The action sends a POST request to {api_base_url}/webhooks/integrations/custom with your workflow configuration.
2. Bugster Cloud matches the request to your workflow and triggers the configured test suite.
3. commit_sha and branch are auto-detected from the GitHub Actions context, enabling GitHub Check Runs and PR comments when available.
4. Reports (Slack, email, PR comments) are sent based on the workflow's report configuration in the Bugster dashboard.

---

Migrating from v1

v2 introduces workflow_id as a required input and removes environment_url. The test suite, environment, and reports are now configured in the Bugster dashboard workflow instead of being passed at runtime.

v1	v2
environment_url (required)	Removed (configured in workflow)
No workflow_id	workflow_id (required)
@v1	@v2

Users on @v1 are unaffected — the v1 tag remains available.