https://github.com/l-lin/spectral-comment-action

Comments pull requests with Spectral linter outputs
https://github.com/l-lin/spectral-comment-action

Last synced: 23 days ago
JSON representation

Comments pull requests with Spectral linter outputs

• Host: GitHub
• URL: https://github.com/l-lin/spectral-comment-action
• Owner: l-lin
• License: mit
• Created: 2020-03-16T08:24:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T08:57:25.000Z (about 2 years ago)
• Last Synced: 2025-03-24T02:36:40.944Z (about 1 month ago)
• Language: JavaScript
• Size: 1.75 MB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



  



# Spectral comment action

> Comments pull requests with [Spectral linter](https://github.com/stoplightio/spectral) linter

> outputs using Github action

![spectral-comment-action](./spectral-comment-action-sample.png)

Check [PR showcase](https://github.com/l-lin/spectral-comment-action/pull/3#issuecomment-600786379).

## Usage

Add or edit an existing workflow:

```yaml

name: "test-action"

on:

  # only works on pull requests

  pull_request:

jobs:

  test:

    name: Lint OpenAPI

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - uses: l-lin/[email protected]

      with:

        github-token: ${{ secrets.GITHUB_TOKEN }}

        file-glob: sample/*.yml

```

## License

[MIT](./LICENSE)