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

Lint Markdown With Github Actions #73

Merged
merged 6 commits into from
Jul 2, 2021
Merged

Lint Markdown With Github Actions #73

merged 6 commits into from
Jul 2, 2021

Conversation

tuckerzp
Copy link
Contributor

@tuckerzp tuckerzp commented Jul 1, 2021

This expands #59 to add markdown linting to Github actions

@kylelaker
Copy link
Contributor

So because of VALIDATE_ALL_CODEBASE: false we only lint changed files... I wonder if we should either remove it or change it to true? Notice that no Markdown files actually got linted. You could also change one. But that'd cause conflicts with #63 since that is changing the README significantly.

Do we need to do the whole config file? Or should we only set values we care about (like line length and stern mode)?

tuckerzp and others added 5 commits July 1, 2021 16:45
Removed redundant comments and instead linked rules from default
markdownlint.yaml file. Also set line_length to 120 & stern mode to true
based on discussion.
This adjusts the rules in the super-linter to run the specific linters
we actually want. Additionally, go back to only linting changed files to
reduce unrelated failures. We can go back to the full codebase likely
after EGRC-168 and EGRC-412.
We should enable all rules by default, leverage their default
configurations, and allow our configuration file to highlight where
we are overriding the default values.
@kylelaker
Copy link
Contributor

Looks like we should be okay to merge this without impacting #63.

@kylelaker
Copy link
Contributor

Also I want to highlight, I've broken my own rules here. This PR now addresses two somewhat unrelated issues. It:

  1. Fixes issues we've been having with the JavaScript dependencies
  2. Adds markdownlint as a linter

This is the kind of creep on PRs that it can take care to avoid; so I wanted to highlight it since this is a good example.

@tuckerzp
Copy link
Contributor Author

tuckerzp commented Jul 2, 2021

Looks good to me! Thanks for your help on this @kylelaker

Copy link
Contributor

@hreineck hreineck left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@hreineck hreineck merged commit 96e6a21 into develop Jul 2, 2021
@rgauss rgauss deleted the EGRC-435 branch July 8, 2021 11:59
@tuckerzp tuckerzp self-assigned this Jul 27, 2021
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.

None yet

5 participants