CircleCI (v1)

CircleCI integration summary

Stitch’s CircleCI integration replicates data using the CircleCI API v2. Refer to the Schema section for a list of objects available for replication.

CircleCI feature snapshot

A high-level look at Stitch's CircleCI (v1) integration, including release status, useful links, and the features supported in Stitch.

Connecting CircleCI

Step 1: Create CircleCI API token

1. Log into your CircleCI application.
2. Go to your User settings.
3. Click Personal API Tokens.
4. Click the Create New Token button.
5. The the Token name field, type in a name you will remember - like Stitch Integration.
6. Click the Add API Token button.
7. Copy your new API token and paste it in a safe location, as you will not be able to view it in the application again.

Step 2: Create your project slugs

A project slug is a triplet of the componenets:

• Project type - which can either be github or bitbucket
• Organization - the name of your organization on GitHub or Bitbucket
• Repository - the name of the repository

The project slug takes the form of <project_type>/<org_name>/<repo_name>. For example, the project slug for this CircleCI Singer tap is github/singer-io/circle-ci.

Determine which repositories you would like to include in your Stitch CircleCI integration and list them, separated by spaces, in the project slug format. Keep this list in a safe location.

Step 3: Add CircleCI as a Stitch data source

1. Sign into your Stitch account.

2. On the Stitch Dashboard page, click the Add Integration button.

3. Click the CircleCI icon.

4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

   For example, the name “Stitch CircleCI” would create a schema called stitch_circleci in the destination. Note: Schema names cannot be changed after you save the integration.

5. In the Project Slugs field, paste the list of project slugs you created in step 2.
6. In the Token field, paste the API token you created in step 1.

Step 4: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your CircleCI integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond CircleCI’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 5: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

CircleCI integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 6: Set objects to replicate

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

• Selection options
• Individual tables and columns
• All tables and columns

Initial and historical replication jobs

After you finish setting up CircleCI, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

CircleCI table reference

jobs._pipeline_id = pipelines.id

jobs._pipeline_id = workflows.pipeline_id

jobs._workflow_id = workflows.id

pipelines.id = jobs._pipeline_id

pipelines.id = workflows.pipeline_id

workflows.pipeline_id = pipelines.id

workflows.pipeline_id = jobs._pipeline_id

workflows.id = jobs._workflow_id

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.