infrastructure/gitlab-ci
2
0
Fork 0
Code Issues 17 Pull Requests 1 Actions Projects Releases 21 Wiki Activity

docs(markdown_lint): completed the job docs.

Browse Source 
fixes #12
This commit is contained in:
Jon Lockwood
2022-01-23 11:04:00 +09:30
parent 5c05ed7605
commit 6363ea377c
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
validation/markdown_lint.md
View File

@ -1,5 +1,5 @@
# Markdown File Linting # Markdown File Linting
Summary of job here This job lints markdown files as part of the validation CI stage. It is designated to run on all branches. If any errors are found, the generated JUnit test report will let you know what errors were found.
This job provides the following badge: This job provides the following badge:
@ -7,7 +7,9 @@ This job provides the following badge:
## Dependencies ## Dependencies
- _None_ - **Optional** file `.markdownlint.json` in repository root with any rules you wish to specify
- **Mandatory** file `.markdownlint-cli2.jsonc` in the repository root so that a Junit test report is created.
## your .gitlab-ci.yml changes ## your .gitlab-ci.yml changes
To use this job add the following to your `.gitlab-ci.yml` file To use this job add the following to your `.gitlab-ci.yml` file