search

kserve / open-inference-protocol

Repository for open inference protocol specification
Apache License 2.0
42 stars 10 forks source link

Add linter for OpenApi and grpc proto in github actions CI #11

Closed sivanantha321 closed 1 year ago

sivanantha321 commented 1 year ago

Fixes #10

sivanantha321 commented 1 year ago

Nice one @sivanantha321 ! We've been wanting to add an OpenAPI linter for a while.

Out of curiosity, couldn't we just use one of the existing OpenAPI linters in available in the GH Actions marketplace? These tend to work well, and would reduce the maintenance burden of having to maintain our own action.

@adriangonz I do agree with you interms of maintenance. Most of the linters available in the github actions is unmaintained. I tried using the openapi-lint-action which seemed better than other actions available. But it didn't have support for ignoring lint errors. So I modified the code to add support for ignoring lint errors. Btw, this action is also unmaintained. If you happen to come across a better linter action, I'd greatly appreciate your recommendation :).

adriangonz commented 1 year ago

I can see that the openapi-lint-action repo seems maintained, so I'd be more keen towards using that instead of having one within the repo.

Wouldn't it be good to raise those lint errors anyway?

yuzisun commented 1 year ago

/lgtm /approve