Prerequisites to run tests in a GitHub Actions Workflow

Before you configure a test run for test resources, you must complete certain tasks to run the test resources in a GitHub Actions Workflow.

You must be familiar with creating projects and running test resources in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).

You must complete the following tasks to set up and use Test Integrations and APIs:
  • Install Test Integrations and APIs. See Installation.
  • Posses valid licenses to use Test Integrations and APIs. See Managing licenses.
  • Create tests in Test Integrations and APIs. See Tests: Overview and tasks.
  • Open the project to view the details of the test resources that you want to run in a GitHub Actions Workflow.
    You must note the following details of the test resource that are to be provided in the YAML file for the GitHub Action:
    • The path to the location where the Test Integrations and APIs project resides.
    • The name of the Test Integrations and APIs project.
    • The name of the environment that is configured in your Test Integrations and APIs project.
    • The name of the test in your Test Integrations and APIs project.
You must complete the following tasks outside of Test Integrations and APIs:
  • Create an empty Git repository on any GitHub Enterprise server, if you do not already use Git repositories to store the test resources that you create. For more information about creating Git repositories, refer to Creating a new repository.
    If you already use Git repositories to store test resources created, you can use the same Git repositories.
    Note: You must have the required privileges in the Git repository to create a GitHub Actions Workflow.
  • Enable the GitHub Actions option in the Git repository, if it is not available as an option to use. For more information about enabling the GitHub Actions, refer to Learn about GitHub Actions.
  • Set up self-hosted runners on your computer. For more information, refer to Adding self-hosted runners.

You can continue to configure a run as a GitHub Action, see Configuring a test run in a GitHub Actions Workflow.