GitHub Actions

GitHub Actions

AIO Tests now supports direct integration with GitHub Actions, enabling seamless connectivity between your test management workflows and your CI/CD pipeline. This enhancement allows users to trigger workflows and fetch results directly within the AIO Tests interface, eliminating the need to switch between tools.

To get started, you can configure your CI/CD system to link your GitHub Actions workflows with AIO Tests. Once configured, you can create AIO jobs that map directly to your GitHub Actions workflows, enabling automated execution and result retrieval with ease.

1. Setting up a CI/CD system

2. Setup Credentials

3. Configure workflow

4. Triggering Jobs

  1. Troubleshooting Guide

Steps to get started:

1. Setting up a CI/CD system

While you are within AIO Tests App, navigate to the Cycles screen, click on the CI icon as shown below.

image-20241203-141732.png

Click on Setup CI/CD system

From the CI/CD System Type dropdown, select GitHub as your preferred CI/CD system.

 

You can connect either GitHub Cloud or GitHub Enterprise, depending on your organization’s setup.

 

 For GitHub Cloud Users

  1. Select the GitHub Cloud radio button.

  2. Enter the following details:

    • CI/CD System Name: A user-friendly name to identify this integration.

    • Owner/Organization Name: Your GitHub username or organization name where the workflows reside.

 

For GitHub Enterprise Users

  1. Select the GitHub Enterprise radio button.

  2. Enter the following details:

    • CI/CD System Name: A user-friendly name to identify this integration.

    • Host URL: The URL of your GitHub Enterprise server.

    • Owner/Organization Name: Your GitHub username or organization name.

 

image-20250605-090420.png

Note: the system should be accessible from outside network.  Only valid URLs with https://  are supported.

 

2. Setup Credentials

Once your GitHub CI/CD system is created in AIO Tests, the next step is to add system credentials to enable access to GitHub Actions.

AIO Tests uses GitHub API tokens to authenticate and access your workflows. GitHub supports two types of tokens:

  • Classic Personal Access Tokens (PAT)

  • Fine-Grained Personal Access Tokens

You can choose either, depending on your organization’s security policies and access requirements.

 


Generating a Classic Personal Access Token (PAT)

Use a classic token if you want a simpler setup with access to all repositories under your account or organization.

Required Scope:

  • repo – Grants full access to private repositories, including reading workflows and triggering actions.

🔧 Steps to Generate:

  1. Go to https://github.com/settings/tokens .

  2. Under "Personal Access Tokens", click "Generate new token (classic)".

  3. Give your token a name and set an expiration date (recommended for security).

  4. In Select scopes, check:

    • ✅ repo (this includes access to actions and contents)

  5. Click "Generate token".

  6. Copy the token and store it securely. You’ll need to paste it into AIO Tests.

classic-tokens-config.png

 

Generating a Fine-Grained Personal Access Token

Use a fine-grained token for more control over access. You can specify which repositories and permissions the token should have.

Required Repository Permissions:

Permission

Access Level

Actions

Read and write

Contents

Read only

Environments

Read only

Metadata

Read only

🔧 Steps to Generate:

  1. Go to https://github.com/settings/personal-access-tokens .

  2. Under "Fine-grained tokens", click "Generate new token".

  3. Enter a name and expiration date.

  4. Choose the organization and specific repositories this token should have access to.

  5. Under Repository permissions, configure the following:

    • ✅ Actions → Read and write

    • ✅ Contents → Read only

    • ✅ Environments → Read only

    • ✅ Metadata → Read only

  6. Click "Generate token".

  7. Copy the token and store it securely. Use it when setting up credentials in AIO Tests.

Adding Credentials In AIO

Navigate to to My settings > CI/CD Credentials > Add System Credential > GitHub

image-20250605-092108.png

Enter the generated token and click on save.

Note: CI/CD credentials are 1 per system shown in my settings, if token is changed in GitHub, you need to change in AIO Tests.

3. Configure Workflow

Once a valid system credential is added, you can configure or add new workflows (referred to as "jobs" in AIO), edit the system name, view error logs, and delete systems.

Simply Click on the (CI) icon on the right and you should get a prompt referral image below:

image-20250605-092843.png
 CI/CD systems referral image

To Configure/Add New job, click on the workflow icon (blue arrow)

To Edit an existing job, click on the edit icon. (green arrow)

To view Job Logs, click on the logs icon. (yellow arrow)

To Delete a job, click on the trash icon. (red arrow)

Steps to Configure a Job

  1. Click the workflow icon (blue arrow).

image-20250605-100343.png
  1. Select "Configure New Job."

image-20250605-101006.png
  1. Enter the following details:

    • Name

    • Job Description

    • Repository Name

  2. After entering the repository name, you can search for it. If the repository name is valid, additional input fields will be displayed.

image-20250605-101331.png
  1. Select the desired workflow and branch from the available options.

  2. If the selected workflow includes parameters, you can define them in the Job Parameters section:

    • Enter the name exactly as it appears in the GitHub workflow.

image-20250605-101759.png
Sample Job Parameters

AIO Auto Fill Value Type is a special AIO-supported type. It allows you to use AIO fields such as:

  • Project_Key

  • Cycle_Key

  • Case_Key_List
    These fields will be automatically populated by AIO Tests when the job is triggered.

Authentication options:

image-20241203-143523.png

Job Executor Credentials: Whoever is triggering the job, they can use their credentials irrespective of who has created the job.

User Credentials: A specific user can share his/her credential and only that can be used to trigger the jobs. Users setting up the job or editing the job can basically share their credentials for execution with the team.

Custom Credentials: Any automation user from the team can use their credentials, it can be used for all the jobs. This can be helpful if team uses a shared automation user.

4. Triggering Jobs

Once jobs are setup, they can be triggered from either the Cycle view or the Cycle Listing view. Click on the CI button on either of the screens.

Select the job to be triggered and click on the Trigger button.

image-20250605-102049.png

Modify/Add the required parameter values for the build and click on the Trigger button.

image-20250605-102109.png
Ready to Trigger a job via AIO Tests

5. Troubleshooting guide

  • Workflow not appearing?
    → The workflow must be part of the main branch or executed at least once before it becomes visible.

  • Limited to 10 parameters?
    → GitHub restricts workflows to a maximum of 10 input parameters.

  • Request size too large?
    → GitHub accepts request bodies up to 65,535 characters. Requests exceeding this size may fail.

  • Workflow stopped working after changes?
    → If you’ve renamed the workflow in GitHub, make sure to update the name in AIO to reflect that change.