stoplightio / spectral-action

GitHub Action wrapper for Spectral - a JSON/YAML/OpenAPI/AsyncAPI/etc linter with custom rule support.
https://stoplight.io/open-source/spectral
Apache License 2.0
90 stars 46 forks source link

Update README.md to represent current ruleset default behavior (and fix broken link) #636

Closed bradlet closed 2 years ago

bradlet commented 2 years ago

In the upgrade to v0.6~ it looks like default behavior -- to use a built-in/core ruleset in the case that no ruleset spec exists in the user's Github workspace -- was either broken or purposefully removed. This PR just updates the README to represent the current functionality.

(ALSO) fixes a broken link to the Spectral Rulesets page.

Motivation and Context

The README makes it sound like you can avoid specifying or creating a local spec for your ruleset when using spectral-action in your CI. That is no longer the case!

635

Description

Update the README to both: a) Stop indicating that spectral-action will use a core ruleset if none exist locally b) Provide a simple ruleset setup example for users who want to simply use a core ruleset.

How Has This Been Tested?

It's just a readme update!

Screenshot(s)/recordings(s)

N/A

Types of changes

N/A

Checklist

N/A