-
Notifications
You must be signed in to change notification settings - Fork 4
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
Providers should have a lint workflow/step on the docs
folder content
#1100
Comments
Thank you for alerting us here, @ringods. I've gone over open registry PRs and this is currently affecting only the three providers you listed. The configured markdownlint options can be found in the registry here. Summary of linting rules failing:
It seems to me at first glance that these particular linting rules are currently too strict for the
There's a few options:
I'm leaning towards a mix of 4 and 1:
|
When a resource provider package contains a
docs
folder, the content should be linted. This workflow/step should pass before a release can happen.When the content is not correct, these files are copied over to the registry for publishing and it fails the publishing there without any feedback loop back to the source.
Example: MongoDB Atlas is currently at v3.20.1. All versions from v3.18.1 failed publishing so far:
The text was updated successfully, but these errors were encountered: