Integrate with GitHub Actions

Run a GitHub Action to get Octomind test results into your pull request comments

CI/CD pipeline integration

In order to integrate Octomind into your CI/CD pipeline, you will need a GitHub Action and a GitHub App.

Octomind GitHub Flow

1. Setup CI Github Action

Include the following GitHub Action into your CI/CD build pipeline on pull request. See git action docs for more details

- uses: OctoMind-dev/automagically-action-execute@v2
  with:
    url: <publicly accessible url to your deployment>
    token: ${{ secrets.OCTOMIND_API_KEY }}
    testTargetId: <your testTargetId from your octomind project>
    blocking: false

Please make sure to integrate the GitHub action AFTER your deployment step. You have to link octomind to your publicly accessible app / branch deployment url to run tests on it.

Show how to create an API key

The option to create your API key can be found within the settings menu.

Project settings menu icon, 12/2025

Click on Create an API key.

Create an API key button, 12/2025

You then will be navigated to our auth provider where you can create a new organization-level API key.

Add the API key to your CI provider as a secret to run test reports from the CI.

Show how to get your test target id

You can get your test target ID from the octomind landing page once signed-in. If you are greeted with the 'Setup your autonomous end-to-end tests' message, please sign-in first

The option to copy your test target ID can be found within the settings menu.

project settings, 12/2025

Click on the copy test target id.

Copy test target ID

2. Install GitHub App

We need read and write access to pull requests ONLY so we are allowed to comment back with test results. We won’t be able to see your code.

Install the GitHub App from here https://github.com/apps/octomind-dev.

Octomind GitHub App install, screenshot 07/2023

3. See it in action

Octomind automatically runs tests on your pull request, and comments with a summary in your PR.

Example of Octomind test results in a pull request comment, screenshot 06/2023