Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xuorig/redocly-cli-lint-action
https://github.com/xuorig/redocly-cli-lint-action
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/xuorig/redocly-cli-lint-action
- Owner: xuorig
- License: mit
- Created: 2021-01-25T16:25:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T12:00:48.000Z (almost 2 years ago)
- Last Synced: 2024-10-16T00:32:13.222Z (2 months ago)
- Language: TypeScript
- Size: 31.9 MB
- Stars: 1
- Watchers: 2
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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 Linton:
- pushjobs:
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