[WIP] - feat(CI): add a GitHub action to lint the Markdown and YAML files. #361
Conversation
jbampton
force-pushed
the
lint-markdown-and-yaml
branch
2 times, most recently
from
3aabd3d to
162e87d
Compare
|
Hey @martin-g I have moved both config files to the If we put them in the |
|
Thanks! Looks better now! |
jbampton
force-pushed
the
lint-markdown-and-yaml
branch
from
162e87d to
29e60ab
Compare
|
Hey @markt-asf what do you think about this PR ? |
|
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. |
Add a basic `markdownlint` config file. Add a `yamllint` config file. Lint both Markdown and YAML files.
jbampton
force-pushed
the
lint-markdown-and-yaml
branch
from
29e60ab to
d7290cd
Compare
|
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
changed the title
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: yaml-lint | ||
| uses: ibiqlik/action-yamllint@v3 |
There was a problem hiding this comment.
YAML Lint is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation. The new ASF rules mean we can't use third party scripts for GitHub Actions. https://github.com/marketplace/actions/yaml-lint
This YAML check with yamllint can be refactored to run on the official Python GitHub action by installing and running yamllint with pip.
| - master | ||
| pull_request: | ||
| branches: | ||
| - master |
There was a problem hiding this comment.
Linters should probably only rull on pull request to speed up build times.
Linting is a more minor test etc.
jbampton
changed the title
Add a basic
markdownlintconfig file.Add a
yamllintconfig file.Lint both Markdown and YAML files.