Skip to content
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.

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

Upping the checkout action in the swagger validation to remove a warning #275

Merged
merged 3 commits into from
Apr 8, 2024
Merged

Conversation

jimbobbennett
Copy link
Contributor

What type of PR is this?

Add one of the following kinds:

  • cleanup

What this PR does / why we need it:

The swagger validation action was missing a name, and this is added here:

image

Becomes:

image

Also this action was using v3 of the checkout action, giving a warning suggesting an upgrade to v4.

image

This upgrades the action version to remove this warning.

Which issue(s) this PR fixes:

No issue raised as this is a cleanup PR

Special notes for reviewers:

None

Changelog input

No changeling needed - this is an internal change

Copy link

linux-foundation-easycla bot commented Mar 27, 2024

CLA Signed


The committers listed above are authorized under a signed CLA.

@hdamker
Copy link
Collaborator

hdamker commented Mar 27, 2024

LGTM

But:
@RandyLevensalor @eric-murray do we need the Swagger Editor Validator still in addition to MegaLinter/Spectral? Just asking as https://github.com/camaraproject/Commonalities/tree/main/artifacts/linting_rules does not have it.

@jimbobbennett
Copy link
Contributor Author

LGTM

But: @RandyLevensalor @eric-murray do we need the Swagger Editor Validator still in addition to MegaLinter/Spectral? Just asking as https://github.com/camaraproject/Commonalities/tree/main/artifacts/linting_rules does not have it.

The spectral action is workflow dispatch only, and shows 20 warnings and 2 hints when run. Would these need to be cleaned up first?

@RandyLevensalor
Copy link
Collaborator

LGTM

But: @RandyLevensalor @eric-murray do we need the Swagger Editor Validator still in addition to MegaLinter/Spectral? Just asking as https://github.com/camaraproject/Commonalities/tree/main/artifacts/linting_rules does not have it.

Since we include swagger editor in the documentation in the readme, I like this check to help validate that the link from our docs will work.

To that point, I think we should add https://github.com/marketplace/actions/redoc-cli-github-action for redoc as well. If there's agreement, I can add this in a separate pr.

Maybe adding these checks and the links in the readme would be worth including in commonalities.

@hdamker
Copy link
Collaborator

hdamker commented Mar 27, 2024

To that point, I think we should add https://github.com/marketplace/actions/redoc-cli-github-action for redoc as well. If there's agreement, I can add this in a separate pr.

This action is not a pure check, but creates a static HTML file, if I read it correctly.

But anyway, we should open an issue if we want to discuss that further, here we are ready to merge, I suggest.

@hdamker hdamker merged commit a5b1393 into camaraproject:main Apr 8, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants