The following example shows how to use Momentic with CircleCI. For more usage examples, see the momentic-ai/examples repository. For a given root package.json:
package.json
{
  "name": "my-momentic-repo",
  "scripts": {},
  "devDependencies": {
    "momentic": "latest"
  }
}
Create a file called .circleci/config.yml in your repository with the following contents:
config.yml
version: 2.1
orbs:
  node: circleci/[email protected]
workflows:
  test:
    jobs:
      - test
jobs:
  test:
    docker:
      - image: cimg/node:lts
    steps:
      - checkout
      - node/install-packages

      - run:
          name: Install browsers
          command: npx momentic install-browsers --all

      - run:
          name: Run Momentic tests
          command: npx momentic run
          when: always

      - run:
          name: Upload results
          command: npx momentic results upload test-results
          when: always

​
Authentication

To run any commands, you must authenticate with Momentic. You can do this by setting the MOMENTIC_API_KEY environment variable in your CircleCI project settings.
  1. Create an API key in Momentic Cloud.
Copy the value to a safe place. You’ll need it in a moment.
  1. Go to your CircleCI project settings and click on the Environment Variables tab. Create a new secret called MOMENTIC_API_KEY and enter the value of your API key.
  1. CircleCI automatically loads environment variables stored in project settings into the CI environment. No modifications are necessary for the CI file.

​
Sharding

If you have a large test suite, you can use sharding to run tests in parallel. This can significantly speed up your CI runs. To shard the test suite, 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. In order to collect test results inside a single run group in Momentic cloud, you need to add a separate step after all tests complete to merge and upload results.
config.yml
version: 2.1
orbs:
  node: circleci/[email protected]

jobs:
  test:
    parallelism: 2
    docker:
      - image: cimg/node:lts
    steps:
      - checkout
      - node/install-packages

      - run:
          name: Install browsers
          command: npx momentic install-browsers --all

      - run:
          name: Run tests
          command: |
            npx momentic run \
              --output-dir test-results/shard-${CIRCLE_NODE_INDEX} \
              --shard-index $(($CIRCLE_NODE_INDEX+1)) \
              --shard-count ${CIRCLE_NODE_TOTAL}

      - store_artifacts:
          when: always
          path: ./test-results

      - persist_to_workspace:
          when: always
          root: .
          paths:
            - test-results

  upload-results:
    executor: node
    steps:
      - checkout
      - node/install-packages

      - attach_workspace:
          at: .

      - run:
          name: Merge test results
          command: npx momentic results merge --output-dir test-results/merged test-results

      - run:
          name: Upload test results
          command: npx momentic results upload test-results/merged

workflows:
  test:
    jobs:
      - run-tests
      - upload-results:
          requires:
            - run-tests
          when: always