Skip to main content

CircleCI Integration

Marketplace | Github Repository

Introduction

In order to integrate with CircleCI, you need to use our Deepcrawl Automate CircleCI orb:

deepcrawl/deepcrawl-test is exposing the run-build job which will run a build on Deepcrawl Automate.

How to use

In order to use Deepcrawl Automate CircleCI Orb, you need to:

  1. Create a CircleCI context deepcrawl-test, which contains the following environment variables:
  • DEEPCRAWL_TEST_USER_KEY_ID
  • DEEPCRAWL_TEST_USER_KEY_SECRET

Both environment variables should be set by creating a new API key here.

  1. Setup your CircleCI workflow (example):
version: 2.1
orbs:
deepcrawl-test: deepcrawl/deepcrawl-test@1.0.0
workflows:
deploy:
jobs:
- deepcrawl-test/run-build:
# Context defined at step 1
context: deepcrawl-test
# Test suite ID created in Deepcrawl Automate
testSuiteId: "YOUR_TEST_SUITE_ID"
# Can be used to make it non-blocking
startOnly: false
caution

Make sure to run this job after your website is deployed, by using requires property of the job.