spectral-action - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #android #machine-learning #rust #deep-learning #linux #macos #vue #pytorch #mcp #openai

spectral-action

(★ 103)

GitHub Action wrapper for Spectral - a JSON/YAML/OpenAPI/AsyncAPI/etc linter with custom rule support.

File Explorer

Download Latest Version (.zip)

- - combine_prs_dependabot.yml
  - latest-tag.yml
  - spectral.yml
- - oasDiscriminator.js
  - oasDocumentSchema.js
  - oasExample.js
  - oasOpFormDataConsumeCheck.js
  - oasOpIdUnique.js
  - oasOpParams.js
  - oasOpSecurityDefined.js
  - oasOpSuccessResponse.js
  - oasPathParam.js
  - oasSchema.js
  - oasTagDefined.js
  - oasUnusedComponent.js
  - refSiblings.js
  - typedEnum.js
- styleguide.json
- test.oas.yml
- .editorconfig
- .prettierrc.js
- config.ts
- getRuleset.ts
- index.ts
- octokit.ts
- spectral.ts
.dockerignore
.gitignore
.my-custom.spectral.yml
.prettierrc.js
.spectral.json
action.yml
Dockerfile
image.png
LICENSE
package.json
README.md
tsconfig.json
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/stoplightio/spectral-action

Downloads the entire project code from GitHub to your computer.

cd spectral-action

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t spectral-action .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 spectral-action

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Spectral Linter Action

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.

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

## Usage

See [action.yml](action.yml)

```yaml
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@v3

# Run Spectral
      - uses: stoplightio/spectral-action@latest
        with:
          file_glob: 'doc/api/*.yaml'
```

### Inputs

- **file_glob:** Pattern describing the set of files to lint. Defaults to `*.oas.{json,yml,yaml}`. (_Note:_ Pattern syntax is documented in the [fast-glob](https://www.npmjs.com/package/fast-glob) package documentation)
- **spectral_ruleset:** Custom ruleset to load in Spectral. When unspecified, will try to load the default `.spectral.yaml` ruleset if it exists.

## Configuration

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

However, if you'd like to simply use a core ruleset without additional configuration, create a `.spectral.yml` in you repository's root with only the contents: `extends: ["spectral:{rulesetTagHere}"]`