Skip to content

Commit

Permalink
feat: custom rulesets
Browse files Browse the repository at this point in the history
  • Loading branch information
Phil Sturgeon committed Feb 25, 2020
1 parent 7616e77 commit 783e876
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
# Spectral Lint Action
# Spectral Linter Action

![](https://raw.githubusercontent.com/stoplightio/spectral/master/img/spectral-banner.png)

This action uses [Spectral 4.x](https://github.com/stoplightio/spectral) to lint your OpenAPI files.
This action uses [Spectral](https://github.com/stoplightio/spectral) from [Stoplight](https://stoplight.io/) to lint your OpenAPI documents, or any other JSON/YAML files.

![](./image.png)

## Install

```json
name: Run Spectral on Pull Requests

on:
- pull_request

jobs:
build:
name: Run Spectral
runs-on: ubuntu-latest
steps:

# Check out the repository
- uses: actions/checkout@v1

# Run Spectral
- uses: stoplightio/spectral-action@v0.5.5
```

## Configuration

Spectral Action will respect your [Spectral Rulesets](https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/getting-started/rulesets.md), which can be defined, extended, and overriden by placing `.spectral.yml` in the root of your repository.


0 comments on commit 783e876

Please sign in to comment.