Skip to main content

​
Overview

The GitHub integration connects your repository to an Octomind test target. Once installed, Octomind will automatically check new pull requests for relevant changes and, when needed, create a Test Plan. You can then use the Octomind GitHub Action to run either:
  • regular test execution (default)
  • Test Plan exploration (visual agent that explores the changes and records a video)

​
Prerequisites

  • Access to an Octomind project
  • A GitHub organization or repository where you can install GitHub Apps

​
1. Open the integration flow in Octomind

Go to your project settings and open the Integrations tab.
Settings modal showing CI integration and GitHub add integration button

​
Create an API key

An API key is required for CI integration.

​
Copy your test target id

You’ll need the test target id in your GitHub workflow.

​
2. Install the Octomind GitHub App

Click add integration in the GitHub integration row. In GitHub, choose the organization/account and select which repositories Octomind should have access to.
We only request the permissions required to create and update pull request comments / checks. We do not need access to your code.
GitHub App permissions and repository selection

​
3. Connect a repository to a test target

After installation, return to Octomind.
  • Select the organization and repository you installed the app for.
  • Github will redirect you back to the settings modal.
From now on, Octomind will evaluate new pull requests for test impact and create a Test Plan when needed.
Example Test Plan comment on a pull request

​
4. Add the GitHub Action to your workflow

Add the Octomind Action to your CI pipeline after your deployment step so the URL is reachable.
Make sure the url points to a publicly accessible deployment (e.g. preview deployment). Otherwise Octomind cannot run tests or exploration.

​
A) Run tests on pull requests (default)

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

​
B) Explore a Test Plan (visual exploration + video)

Use the same action, but set action: explore-test-plan. 
- uses: OctoMind-dev/automagically-action-execute@v3
  with:
    url: <publicly accessible url to your deployment>
    token: ${{ secrets.OCTOMIND_API_KEY }}
    testTargetId: <your testTargetId from your octomind project>
    environmentName: default
    action: explore-test-plan
    blocking: false

​
Example workflow

name: Octomind

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  octomind:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      # Add your build & deployment steps here
      # Ensure the deployed preview is publicly reachable and set PREVIEW_URL

      - name: Octomind (Explore Test Plan)
        uses: OctoMind-dev/automagically-action-execute@v3
        with:
          url: ${{ env.PREVIEW_URL }}
          token: ${{ secrets.OCTOMIND_API_KEY }}
          testTargetId: <your testTargetId from your octomind project>
          environmentName: default
          action: explore-test-plan
          blocking: false