Qase Docs
Help CenterAPI DocsRoadmapSign up for free
  • General
    • Qase docs
    • Get started with the Qase platform
      • Account settings
      • Projects
      • Test suites
      • Test cases
        • Test Case Parameters
        • Test case review
        • Shared steps
        • Import test cases
        • Export test cases
        • Trash bin
        • Muted Tests
        • System fields
        • Nested steps
        • Test case actions
        • Filters
      • Requirements Traceability Report
      • AI Test Case Generator
    • Execute testing
      • Test plan
      • Test runs
      • Configurations
      • Environments
    • Issues tracking
      • Defects
      • Milestones
      • Requirements
    • Analytics
      • Dashboards
      • Queries (QQL, Qase Query Language)
      • Saved queries
    • Webhooks
      • Test Case
      • Test suite
      • Test plan
      • Shared step
      • Milestone
      • Custom field
      • Test run
      • Defect
      • Test review
  • AIDEN
    • AIDEN - QA Architect
  • Guide: Action editor
  • Administration
    • Workspace management
      • Users
      • Invites
      • Groups
      • Roles
      • Fields
      • Custom fields
      • Notifications
      • Tags
      • Attachments
      • Audit logs
      • Hotkeys
    • SSO / SAML instructions
      • AzureAD
      • OneLogin
      • Google Workspace
      • Okta
      • JumpCloud
    • SCIM
      • User lifecycle management with SCIM
      • Enable SCIM
      • Users
      • Discovery features
      • Errors
    • Security
      • SOC 2 Type II / SOC 3
      • ISO/IEC 27001:2022
      • Penetration testing report
      • Subprocessors
      • Qase IP addresses
    • Billing
      • Billing options
    • Subscriptions
      • Free plan
      • Startup plan
      • Business plan
      • Enterprise plan
  • Apps
    • Issue tracking
      • Jira Cloud
      • Jira Server/Datacenter Plugin installation
      • GitHub
      • Asana
      • Linear
      • Monday
      • ClickUp
      • Trello
      • Azure DevOps
      • GitLab
      • YouTrack
      • Redmine
    • CI/CD
      • Jenkins
      • BitBucket
      • GitHub CI
      • GitLab CI
    • Chats
      • Slack
  • Automation
    • Qase API
    • Reporters
      • JavaScript
        • Playwright
        • Cypress
        • Mocha
        • Newman
        • Jest
        • WebDriverIO
        • CucumberJS
        • TestCafe
      • Python
        • Pytest
        • Robot Framework
        • Behave
        • Tavern
      • Java
        • TestNG
        • JUnit 4
        • JUnit 5
        • Cucumber 3 (jvm)
        • Cucumber 4 (jvm)
        • Cucumber 5 (jvm)
        • Cucumber 6 (jvm)
        • Cucumber 7 (jvm)
      • PHP
        • PHPUnit
        • Codeception
      • Kotlin
        • Kaspresso
    • Qase CLI App
      • XCTest
Powered by GitBook
On this page
  • What is GitHub?
  • CI/CD Workflows
  • a. Connect your Workflow
  • b. Start an automated run
  • GitHub Actions
  • Troubleshooting:
  • Useful resource
  1. Apps
  2. CI/CD

GitHub CI

PreviousBitBucketNextGitLab CI

Last updated 4 months ago

What is GitHub?

is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.

CI/CD Workflows


a. Connect your Workflow

Follow these steps to connect a GitHub workflow to Qase:

  1. The inputs and env variables that are required need to be defined in a workflow:

name: Qase Tests
on:
  workflow_dispatch:
    inputs:
      qase_api_base_url:
        description: "Qase API URL"
        required: true
      qase_report:
        description: "Enabled/disabled reporting to Qase"
        required: true
      qase_project_code:
        description: "Qase project code"
        required: true
      qase_run_id:
        description: "Qase Run ID"
        required: true
      qase_run_complete:
        description: "Qase Run autocomplete"
        required: true

env:
  QASE_API_BASE_URL: ${{ inputs.qase_api_base_url }}
  QASE_TESTOPS_PROJECT: ${{ inputs.qase_project_code }}
  QASE_TESTOPS_RUN_ID: ${{ inputs.qase_run_id }}
  QASE_TESTOPS_RUN_COMPLETE: true
  QASE_TESTOPS_API_TOKEN: ${{ secrets.QASE_API_TOKEN }}
  1. Add a step to the first place in the job. It allows to link a GitHub workflow run with a Qase test run.

jobs:
  test:
    timeout-minutes: 60
    runs-on: ubuntu-latest
    steps:
      - uses: cskmnrpt/qase-link-run@v2
        env:
          QASE_TESTOPS_API_TOKEN: ${{ env.QASE_TESTOPS_API_TOKEN }}
  1. Add additional steps to execute your tests.

b. Start an automated run

After the workflow is connected, you can initiate automated test runs from Qase:

  1. From the Test runs screen, click "Start a new Test run", and choose the type as 'Automated'

  1. Choose a CI/CD system to use (Github):

  1. Fill in the required fields:

  1. Click "Start a run" button.

  2. You will be redirected to a test run you started. In the test run details section, you will see a link to the workflow run in GitHub and the current status.

  1. When the tests have been executed, the test run will contain all the results sent by a reporter (it should be properly configured):

GitHub Actions

GitHub Actions allows for reusable functions and workflows, enhancing automation and efficiency.

Qase offers the following actions, which can be integrated into your workflows to streamline tasks.

Troubleshooting:

If integration with GitHub has already been enabled before, it’s required to accept new permissions in the GitHub application settings.

In case of insufficient permissions after clicking on the “Start a run” button, a message with an error will appear.

Useful resource

One of Qase should be used in order to receive the test run results.

in Qase and add it to the QASE_API_TOKEN secret in your .

An example of Github integration:

reporter apps
Create a token
GitHub repository settings
Create Qase test runs
Complete (close) Qase test runs
Send test reports in JUnit, XCTest, Qase, and Allure formats
Create Qase environments
Create Qase milestones
https://github.com/qase-tms/qase-javascript/tree/master/examples/github-qase-integration
GitHub