---
updatedAt: 2026-03-05T13:26:45.000Z
agentTools:
  projectIndex: https://help.rainforestqa.com/llms.txt
---

# GitHub

Learn how to run your Rainforest tests using a GitHub Action.

<a href="https://github.com/" target="_blank">GitHub</a> is a Microsoft-owned developer platform offering distributed version control and source code management. Using a GitHub Action, you can automate, customize, and execute your Rainforest test runs.

See our <a href="https://github.com/marketplace/actions/rainforest-qa-github-action" target="_blank">Rainforest QA GitHub Action</a> article for a more thorough explanation of how you can incorporate Rainforest tests into your release process using GitHub.

## Getting Started with GitHub Actions

Check out the <a href="https://docs.github.com/en/actions/quickstart" target="_blank">quick start guide</a> to learn about GitHub Actions.

## The Rainforest API Token

Before configuring a GitHub Action, you need a Rainforest API token. You can find yours by navigating to the <a href="https://app.rainforestqa.com/settings/integrations" target="_blank">Integrations</a> page and clicking the Generate API Token button.

<Image title="Generate API Token.png" alt={622} src="https://files.readme.io/955589d-Generate_API_Token.png">
  Generating an API token.
</Image>

**Note:** Never expose the token in your <code>.github/workflows/`<workflow>`.yml</code> file. Instead, use a <a href="https://docs.github.com/en/actions/security-guides/encrypted-secrets" target="_blank">GitHub encrypted secret</a>. Choose a name such as <code>RAINFOREST\_API\_TOKEN</code>.

## Executing a Run Group

A run group is a collection of tests meant to run together. Use run groups to execute multiple tests on a scheduled basis, on demand, or from the command line. Examples include tests for a smoke suite, a regression suite, or a nightly build validation. See <a href="https://help.rainforestqa.com/docs/organizing-tests-by-run-group" target="_blank">Organizing Tests by Run Group</a> for more information.

Choose a run group containing at least one enabled test and run it in GitHub workflows using this Action:

`https://app.rainforestqa.com/run_groups<ID>`

To find your run group ID, navigate to the <a href="https://app.rainforestqa.com/run_groups" target="_blank">Run Groups</a> page and select a run group. The ID appears in your browser’s address bar at the end.

See <a href="https://github.com/marketplace/actions/rainforest-qa-github-action" target="_blank">Rainforest QA GitHub Action</a> to learn about optional parameters you can include.

<hr />

*If you have any questions, reach out to us at <support@rainforestqa.com>.*