Skip to content
Help Center
Browse documentation

Re-explore automatically on every GitHub push

Connect a GitHub repository so each push or merged pull request re-explores your app and refreshes its knowledge. It does not run your tests; use CI for that.

Updated 4 min read

To re-explore your app on every GitHub push, open your project's Integrations tab, choose GitHub, install the TestOptim GitHub App and link a repository. TestOptim then re-explores your app whenever code changes, so your knowledge base stays current.

Important

The GitHub integration re-explores your app. It does not run your tests. To run tests on every push, call TestOptim from your CI pipeline. See Run tests from CI, scripts or an AI assistant.

Before you start

  • You need the Owner or Admin role.
  • Integrations are available on the Startup plan and above. On the Solo plan or a trial you see an upgrade prompt instead of the setup. See Compare plans and limits.
  • You need permission to install a GitHub App on the account or organization that owns the repository.
  • The project must already have its URL set, because exploration visits that URL.

Connect GitHub

  1. Open the project, then select Integrations in the left sidebar.

  2. On the GitHub tab, the card says Not connected. Select Install GitHub App.

    The GitHub tab with Install GitHub App
    Install the TestOptim GitHub App, then pick a repository

  3. GitHub opens. Choose the account and the repositories to give TestOptim access to, then confirm.

  4. Back in TestOptim, if the card shows Repository not set, choose the GitHub account (if you have several) and the Repository, then select Link repository.

The card now says Connected. It shows Connected via (the GitHub App and account), Last delivery and Last exploration. Use Change repository to link another repository or Disconnect to remove the link.

Note

The GitHub approval happens on GitHub's screens, so this article doesn't show them.

If you don't see your repository in the list, select Give the App access to it on GitHub, then refresh the list. You can also install the App on another account.

Choose what triggers an exploration

A settings card, What happens when the repository changes, controls this.

Triggers. Only Push is on by default. To react to merged pull requests only, turn Push off and Pull request merged on.

  • Push: every push to the repository.
  • Pull request merged: only when a pull request is merged, not when it's opened or updated.

If you turn both off, GitHub changes won't start explorations.

Exploration mode

  • Full re-exploration: explore the whole app.
  • Only when watched paths change: add Watch paths, for example src/pages/, and press Enter. A path is a prefix of the changed file's path (case-sensitive), not a pattern. Leave the list empty to explore on any change.
  • Disabled — receive but don't explore: record the events without exploring.

Start exploration automatically is on by default and can be switched off to record deliveries without exploring.

Select Save changes to apply them.

What happens after a push

TestOptim queues an exploration of the project URL, signing in with the project's default login profile if it has one. When it finishes, your knowledge is updated and you get the usual notifications. Exploration doesn't open or reopen issues.

The Recent deliveries list on the GitHub tab shows the last explorations GitHub started, with a status such as Pending, Running, Completed, Failed, Stopped or Timeout.

Warning

Keep these in mind before you connect a busy repository:

  • Every branch triggers it. There is no branch filter, so a push to any branch starts an exploration.
  • It stops a running exploration. If one is in progress, the new one replaces it. If a test run, test generation or verification is running instead, the push does not start an exploration. Nothing is added to Recent deliveries for that push. Push again, or start the exploration yourself, once the other job has finished.
  • It can collide with CI. A push that also starts a CI run is refused while the other job is active, because a project runs one job at a time.
  • It uses your page quota. Explorations count toward your plan's pages per month.
  • Watched paths apply to pushes only. Merged pull requests aren't filtered by path.

Does the GitHub integration run my tests?

No. It only re-explores your app. To run tests on every push, use CI with an API key.

Manual webhook

The tab also offers Set up a webhook manually for repositories you can't install the App on. We recommend the GitHub App, so this article doesn't cover the manual route.