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

Add markdown linting #3990

Merged
merged 6 commits into from Jun 10, 2022
Merged

Add markdown linting #3990

merged 6 commits into from Jun 10, 2022

Conversation

jsumners
Copy link
Member

This PR adds a workflow that will check the line length within Markdown documents in this project. It's possible we could migrate this to the common workflows repo, but I'm not clear if that is possible given how the tools in this workflow work. Anyone is welcome to do their own testing and move it if they determine it viable.

See https://github.com/stupid-org/md-lint/pull/1/files for an example of what a failed check looks like.

Checklist

@jsumners jsumners marked this pull request as draft June 10, 2022 00:19
@jsumners jsumners marked this pull request as ready for review June 10, 2022 00:58
@jsumners jsumners requested review from Fdawgs and mcollina June 10, 2022 00:58
.github/workflows/md-lint.yml Outdated Show resolved Hide resolved
.github/workflows/md-lint.yml Outdated Show resolved Hide resolved
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setup only runs in CI. I think we should be able to run locally too. I think remark might offer a better toolchain but I'm ok with anything I can run locally as well.

(In Node.js TSC we use https://github.com/nodejs/TSC/blob/main/package.json#L7)

.github/workflows/md-lint.yml Outdated Show resolved Hide resolved
.github/workflows/md-lint.yml Show resolved Hide resolved
jsumners and others added 5 commits June 10, 2022 09:42
Co-authored-by: Frazer Smith <frazer.dev@outlook.com>
Co-authored-by: Frazer Smith <frazer.dev@outlook.com>
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Co-authored-by: Frazer Smith <frazer.dev@outlook.com>
@jsumners jsumners merged commit 9e21d28 into main Jun 10, 2022
@jsumners jsumners deleted the add-md-linting branch June 10, 2022 13:53
@Fdawgs
Copy link
Member

Fdawgs commented Jun 13, 2022

Had to remove it as a Required workflow from the main branch protection rules, see #4005 (comment)

@jsumners
Copy link
Member Author

It's a really basic implementation. It should really be implemented as "do markdown changes exist? yes: run check, no: return green".

@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 14, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants