Skip to content

chore: add linter for OpenAPI #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
thomaspoignant wants to merge 4 commits into from
Closed

chore: add linter for OpenAPI #13

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
74480b3
chore: add linter for OpenAPI
thomaspoignant Apr 30, 2024
ceeb117
remove permissions
thomaspoignant Apr 30, 2024
9c228c9
Merge branch 'main' into lint-openapi
thomaspoignant Apr 30, 2024
0ac59fd
remove unused file
thomaspoignant Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/lint-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: "OpenAPI Lint"

on:
pull_request_target:
types:
- opened
- edited
- synchronize

jobs:
openAPILint:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: OpenAPI Lint Checks
uses: nwestfall/openapi-action@v1.0.2
Copy link
Copy Markdown
Contributor

@Kavindu-Dodan Kavindu-Dodan May 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding this action, it seems this has been unmaintained for some time. And I checked alternatives and came across redocly-cli (MIT license) and used their docker image [1] to perform a similar validation

You can see my attempt in the fork [2] and the test GH action failure run in my fork [3]

Let me know your thoughts on this :)

[1] - https://github.com/Redocly/redocly-cli?tab=readme-ov-file#docker
[2] - https://github.com/open-feature/protocol/compare/test-validate
[3] - https://github.com/open-feature/protocol/actions/runs/8913421964/job/24478855581

Copy link
Copy Markdown
Member

@beeme1mr beeme1mr May 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is another option that adds lint violations as annotations in the PR.

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

Copy link
Copy Markdown
Contributor

@Kavindu-Dodan Kavindu-Dodan May 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@beeme1mr checked but I am not super happy yet as there are open issues and PRs that were not addressed recently. We can switch back if we see issues with redocly

with:
github_token: ${{ secrets.GITHUB_TOKEN }}
file: services/openapi.yaml