CI Integration with Github Actions

Once you create a CI job in ACCELQ, you can invoke it as part of a Github pipeline by setting up the ACCLEQ job as a Github Action.

Adding ACCELQ Action to a new Project

Go to your Github Repository. Navigate to Actions, and from the list of available sample template workflows, select any.

Search and select ACCELQ Github-A Connect as shown below

Copy the template code and paste it into the editor. Update the field values as shown below.

Commit and go to Actions to see the run output

Adding ACCELQ Action to an existing workflow

• Go to your Github repository. Navigate to the folder .github > worflows > {your YML file}
• Edit the YML file, and on the right side marketplace section search and select ACCELQ Github-A Connect
• Copy the template code and paste it into the editor. Follow the steps as in the above section

name: ACCELQ Github Action CI

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the "main" branch
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      - name: ACCELQ Github-A Connect
      # You may pin to the exact commit or the version.
        uses: accelQ-Inc/accelq-ci-github-actions@v1.4
        with:
          # Your ACCELQ Application URL in the exact following format: https://<hostname>.accelq.io
            appURL: 'https://accelq.io/'
          # Your ACCELQ User ID
            userName: 'abc@accelq.com'
          # API key available in Profile section of ACCELQ
            apiKey: 'XXXXXXXXXXXXXXXXXXXX'
          # Tenant Code displayed in the Profile section of ACCELQ
            tenantCode: 'accelq'
          # This ID should come from the CI job you saved in ACCELQ application
            jobId: '4614'
          # Run Params(optional) should be JSON string form example: '{"username": "John Todd", "password": "bxW&=UVw"}'
            runParam: '{"username": "XXXX", "password": "XXXXX"}'