Integrate with Vercel CI

Run a GitHub Action to execute Octomind tests on Vercel deployment

If you are using a GitHub Actions workflow to deploy to Vercel with your own .yml files, check out our Quickstart - GitHub Actions guide instead.

CI/CD pipeline integration

We currently do not have a native Vercel integration. If you are using Vercel for your CI, you should be able to use Octomind when following the steps below. If you have any difficulties with it, please, let us know on our Discord.

See also our example vercel-actions integration repo.

1. Include the GitHub Action

Include the following GitHub Action into your CI/CD build pipeline on deployment_status changes:

on: deployment_status

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  octomind:
    if: ${{ github.event.deployment_status.state  == 'success' }}
    name: 🚀🐙 trigger octomind e2e tests 🚀🐙
    runs-on: ubuntu-latest
    steps:
      - uses: OctoMind-dev/automagically-action-execute@v2
        with:
          testTargetId: "<your testTargetId from your octomind project>"
          url: ${{ github.event.deployment_status.target_url }}
          token: ${{ secrets.OCTOMIND_API_KEY }}
          blocking: false

Show how to create an API key

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

Click on Create an API key.

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.

Click on the copy test target id.

2. See it in action

The test report link will be added to the workflow summary of the action, see Example PR action summary