Spectral Scan

Install Spectral Scan action

Spectral Scan is a single self-contained binary, that's easy to get and use. This action installs the latest Spectral version into your PATH.

Example usage

Include this Action as a step in your workflow:

uses: spectral/spectral-action@v2
with:
  spectral-dsn: $SPECTRAL_DSN
  spectral-args: --ok

You can see an example of this Action here

Configuration

You'll need to provide Spectral dsn. You can do so via the SPECTRAL_DSN environment variable. In the below example, the Spectral dsn is retrieved from GitHub secrets.

name: Spectral

on: [push]

env:
  SPECTRAL_DSN: ${{ secrets.SPECTRAL_DSN }}

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Install Spectral
      uses: spectralops/spectral-github-action@v2
      with:
        spectral-dsn: $SPECTRAL_DSN
        spectral-args: --ok
    - name: Spectral Scan
      run: spectral scan

Spectral provides another scan option to audit your Github/Gitlab organizaion, user or repo.

name: Spectral

on: [push]

env:
  SPECTRAL_DSN: ${{ secrets.SPECTRAL_DSN }}

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Install and run Spectral Audit
        uses: spectralops/spectral-github-action@v2
        with:
          spectral-dsn: ${{ secrets.SPECTRAL_DSN }}
          spectral-args: github -k repo -t ${{ secrets.MY_GITHUB_TOKEN }} https://github.com/SpectralOps/spectral-github-action --include-tags base,audit --ok

How to Contribute

We welcome issues to and pull requests against this repository!

License

This project is licensed under the MIT License. See LICENSE for further details.