Continuous Integration

Spectral CLI can be run anywhere that npm packages can be installed and run via CLI, which these days is pretty much any CI solution going.

Here are some examples of Spectral in CI solutions.

CircleCI

Users of CircleCI can take this entire file and save it as .circleci/config.yml, or move the lint job into their existing config.

version: 2.1

orbs:
  node: circleci/node@4.1

jobs:
  lint:
    docker:
      - image: cimg/node:15.1
    steps:
      # Checkout the code as the first step.
      - checkout
      # Create a folder for results to live in
      - run: "[ -d lint-results ] || mkdir lint-results"
      - run:
          name: Run Spectral Lint
          command: npx openlint lint openapi.yaml
            -o lint-results/junit.xml
            -f junit
      - store_test_results:
          path: lint-results

workflows:
  sample:
    jobs:
      - lint

Make sure to change openapi.yaml to point to whatever documents you want to lint.

The -f (format) flag is used in the script to pick the JUnit output format. This is a standard test format that many CI servers understand, and means you should be able to see the errors in the Test interface.

Learn more about CircleCI Configuration, or take a look at this demo repository.

GitHub Action

Spectral has a pre-built Spectral GitHub Action which should speed up implementing Spectral in your GitHub repository.

GitLab

GitLab users can add the following to their .gitlab-ci.yml files:

stages:
  - lint

lint:openlint:
  stage: lint
  image:
    name: openlint/openlint
    entrypoint: [""]
  script:
    - openlint lint -D -f junit -o openlint-report.xml openapi.yaml
  artifacts:
    when: always
    expire_in: 2 weeks
    reports:
      junit: $CI_PROJECT_DIR/openlint-report.xml

Make sure to change openapi.yaml to point to whatever documents you want to lint.

The -f (format) flag is used in the script to pick the JUnit output format. This is a standard test format that many CI servers understand, and means you should be able to see the Spectral output on the merge request page.