Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xuorig/redocly-cli-lint-action


https://github.com/xuorig/redocly-cli-lint-action

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# Redocly OpenAPI Lint Action

This actions uses [redocly/openapi-cli](https://github.com/Redocly/openapi-cli) to lint OpenAPI documents in a repository.

## Usage

See [action.yml](https://github.com/xuorig/redocly-cli-lint-action/blob/main/action.yml).

```yaml
name: OpenAPI Lint

on:
- push

jobs:
build:
name: OpenAPI Lint
runs-on: ubuntu-latest
steps:
# Check out the repository
- uses: actions/checkout@v2

# Run Redocly Lint
- uses: xuorig/[email protected]
with:
entrypoints: 'documents/openapi.yaml'
config: '.redocly.yml'
```

## TODO

- [ ] GitHub Checks Annotations
- [ ] Rule exceptions