Validate in CI

Amplitude Data works best when you integrate it into your continuous integration (CI) workflow alongside your test suite. Amplitude Data integrates with all common CI providers, and you can configure it for custom environments.

After you add Amplitude Data to your CI environment, Amplitude Data verifies your analytics against every build.

Step 1: Create an API token

Create an API token for your Amplitude Data account by going to Settings > API Tokens. Ampli uses this token for authentication when running inside CI to update your tracking plan's implementation status.

Step 2: Configure a CI environment variable

Create an environment variable in your CI service called AMPLI_TOKEN and set it to the API token you created. Use this environment variable to pass the token to ampli status when it runs inside CI.

For example, the Netlify environment variables screen lists environment variables for each site.

Read the documentation for your CI service to get step-by-step instructions:

• Bitbucket Pipelines
• CircleCI
• GitLab CI
• Jenkins
• Travis CI

Step 3: Prepare your project

At this point, you've run ampli pull and ampli status in your project's root folder. The folder contains an ampli.json file with metadata about the current state of the Ampli Wrapper in your project. When you run ampli status on your local machine or in CI, Ampli verifies your analytics against this file.

For non-JavaScript and non-TypeScript projects, you don't need more configuration.

For JavaScript and TypeScript projects, you can install Ampli locally as a dev dependency. Installing Ampli locally in the project's node_modules folder simplifies Ampli installation and usage for your team and CI environment.

Install Ampli as a dev dependency

To install Ampli locally, run npm install @amplitude/ampli -D.

Step 4: Run Ampli in CI

To integrate Ampli with your CI system, change your CI configuration to run ampli status as part of the build process.

Docker containers

Amplitude provides Docker containers that include the dependencies required to run the Ampli CLI.

amplitudeinc/ampli

Use the ampli image to verify any Ampli SDK runtime except .NET.

amplitudeinc/ampli-all

Use the ampli-all image to verify any Ampli SDK runtime, including .NET C#. The ampli-all image is larger than the ampli image.

GitHub Actions

Use Ampli CLI Docker containers in your GitHub Actions workflows by setting the container.image value.

Refer to GitHub's documentation to learn more about how to run GitHub Actions in containers.

name: Ampli Implementation Check
on: pull_request

jobs:
    build:
    runs-on: ubuntu-latest
    container:
        image: amplitudeinc/ampli

    steps:
        - name: Checkout repo
        uses: actions/checkout@v3

        - name: Verify analytics implementation and update status in Data
        run: ampli status -t ${{secrets.AMPLI_TOKEN}} [--update]

Bitbucket Pipelines

Use Ampli CLI Docker containers in your bitbucket-pipelines.yml by setting the image value.

- step:
    name: Run 'ampli status' in CI
    image: amplitudeinc/ampli
        script:
        - ampli status [-u] -t $AMPLI_TOKEN

Other CI systems

The examples above are for GitHub and Bitbucket, but you can use the same images in any CI system that supports containers.

Ampli now runs inside your CI system.