This repository was archived by the owner on Aug 12, 2024. It is now read-only.
Add markdown linter GH Action#318
Merged
exdx merged 2 commits intooperator-framework:mainfrom May 5, 2022
Merged
Conversation
openshift-ci
Bot
added
the
do-not-merge/work-in-progress
openshift-ci
Bot
removed
the
do-not-merge/work-in-progress
Contributor
Author
|
I suppose we could move this under the existing |
Contributor
That seems reasonable to me. |
joelanford
reviewed
May 4, 2022
joelanford
reviewed
May 4, 2022
exdx
force-pushed
the
markdown-linter
branch
4 times, most recently
from
a19f8b1 to
2d0043f
Compare
timflannagan
reviewed
May 4, 2022
timflannagan
approved these changes
May 4, 2022
Member
|
Also: should we separate out the markdown linting violations into it's own commit? |
Contributor
Author
Yes, they should be in their own commit. I squashed everything but will try to split it out 👍 |
tylerslaton
approved these changes
May 5, 2022
Introduce a new linter as part of the sanity check that focuses only on linting markdown files. Having a markdown linter ensures uniform documentation formatting and leads to higher quality documentation. The super-linter action introduced seems like the most up-to-date and well maintained markdown linter available as a GitHub Action.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces a new GH Action specifically for linting the markdown files in the repository. It relies on the https://github.com/github/super-linter project which seems to be the most maintained GH Action for linting and specifically for markdown. It only lints markdown files and does not use any of the other linters included, since golangci-lint is used for Go code in the project.