tomcat icon indicating copy to clipboard operation
tomcat copied to clipboard

[WIP] - feat(CI): add a GitHub action to lint the Markdown and YAML files.

Open jbampton opened this issue 5 years ago • 5 comments

Add a basic markdownlint config file. Add a yamllint config file. Lint both Markdown and YAML files.

jbampton avatar Sep 13 '20 16:09 jbampton

Hey @martin-g I have moved both config files to the .github folder.

If we put them in the .github/workflows/ folder, GitHub will think they are both workflows.

jbampton avatar Sep 15 '20 13:09 jbampton

Thanks! Looks better now! Let's see what others think about this linters.

martin-g avatar Sep 15 '20 13:09 martin-g

Hey @markt-asf what do you think about this PR ?

jbampton avatar Sep 22 '20 14:09 jbampton

A couple of those files appear to be missing ALv2 headers. On that topic, it looks like the markdown files need an ALv2 header if possible as well.

markt-asf avatar Oct 05 '20 18:10 markt-asf

Hey @markt-asf I have rebased and moved the two config files back to the repo root.

The 2 files are not specific to GitHub so say we moved to GitLab we wouldn't want our whole repo config files in a GitHub folder.

I have also now added the licenses to all new files.

jbampton avatar Nov 16 '20 11:11 jbampton