Jira

The Jira integration links visual test runs to Jira issues for tracking and project management.

Setup

Navigate to Settings > Integrations and configure the Jira card:

1. Enter your Jira instance URL (e.g., https://yourteam.atlassian.net)
2. Provide your email and API token (for Cloud) or PAT (for Server/Data Center)
3. Set the project key, issue type, and optional labels
4. Toggle auto-create issues to automatically create Jira issues when diff.detected fires
5. Select which events trigger Jira updates
6. Click Save

Features

• Link test runs to Jira issues using issue keys (e.g., PROJ-123)
• Auto-create Jira issues when visual differences are detected
• Add comments on existing issues when runs start or complete
• Pass Jira keys through the GitHub Action or REST API
• Track visual regression history alongside your project management workflow

Using with CI/CD

When triggering runs from CI, pass the jira-key parameter:

# GitHub Action
- uses: abecms/visualq-action@v1
  with:
    api-key: ${{ secrets.VISUALQ_API_KEY }}
    project: my-website
    jira-key: PROJ-123

# REST API
curl -X POST https://visualq.ai/api/ci/run \
  -H "X-API-Key: $VISUALQ_API_KEY" \
  -d '{"project": "my-website", "jiraKey": "PROJ-123"}'