Skip to main content
This page shows an example config for running Momentic on CircleCI. More reference configs live in momentic-ai/examples. Given this root package.json:
package.json
Create a file called .circleci/config.yml in your repository with the following contents:
config.yml

Authentication

To run any commands, you must authenticate with Momentic. Set the MOMENTIC_API_KEY environment variable in your CircleCI project settings.
  1. Create an API key in the Momentic dashboard.
Copy the value. You add it as a CI secret in the next step.
  1. Go to your CircleCI project settings and click the Environment Variables tab. Create a new secret called MOMENTIC_API_KEY and enter your API key.
CircleCI project settings showing the Environment Variables tab
CircleCI Add Environment Variable dialog
  1. CircleCI automatically loads environment variables stored in project settings into the CI environment. The CI file needs no changes.

Sharding

If you have a large test set, use sharding to run tests in parallel across CI jobs and shorten total run time. To shard your tests, pass the --shard-index and --shard-count options to the momentic run command. The --shard-index is the index of the current shard (starting from 1), and --shard-count is the total number of shards. To collect test results inside a single run group in the Momentic dashboard, add a separate step after all tests complete to merge and upload results.
config.yml