refactor(markdown_lint): move md linting to lint folder

!25

.gitlab-ci.yml

@@ -16,7 +16,7 @@ include:
   - local: $JOB_ROOT_DIR/conventional_commits/.gitlab-ci.yml
   - local: $JOB_ROOT_DIR/git_push_mirror/.gitlab-ci.yml
   - local: $JOB_ROOT_DIR/gitlab_release/.gitlab-ci.yml
-  - local: $JOB_ROOT_DIR/validation/.gitlab-ci.yml
+  - local: $JOB_ROOT_DIR/lint/markdown.gitlab-ci.yml
   - local: $JOB_ROOT_DIR/python/.gitlab-ci.yml
   - template: Security/Dependency-Scanning.gitlab-ci.yml
   #- template: Security/License-Scanning.gitlab-ci.yml

lint/markdown.gitlab-ci.yaml

@@ -32,3 +32,14 @@
         - "**/**.md"
     - when: never
 
+
+
+.Lint_Markdown_Pages:
+  variables:
+    MDLINT_PATHS: "pages/*.md pages/**/*.md pages/**/**/*.md pages/**/**/**/*.md pages/**/**/**/**/**/*.md #CHANGELOG.md !gitlab-ci !website-template"
+  extends: .Lint_Markdown
+  rules:
+    - if: '$CI_COMMIT_BRANCH'
+      exists:
+        - "pages/"
+    - when: never

mkdocs.yml

@@ -38,6 +38,8 @@ nav:
 
     - projects/gitlab-ci/mkdocs-build.md
 
+    - projects/gitlab-ci/markdown_lint.md
+
 - Operations: 
 
   - operations/index.md

pages/projects/gitlab-ci/markdown_lint.md

@@ -1,4 +1,11 @@
-# Markdown File Linting
+---
+title: Markdown File Linting
+description: How to use No Fuss Computings gitlab-ci job for markdown linting
+date: 2021-08-11
+template: project.html
+about: https://gitlab.com/nofusscomputing/projects/gitlab-ci
+---
+
 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.
 
 You can include your linting rules in `.markdownlint.json` which should be within the root of your repository. for the available rules please see the [docs](https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases).

template/website.gitlab-ci.yaml

@@ -4,16 +4,16 @@
 include:
   - local: $JOB_ROOT_DIR/.gitlab-ci_common.yaml
   - local: $JOB_ROOT_DIR/mkdocs/.gitlab-ci.yml
-  - local: $JOB_ROOT_DIR/validation/.gitlab-ci.yml
+  - local: $JOB_ROOT_DIR/lint/markdown.gitlab-ci.yml
 
 
-Lint Markdown:
-    extends: .Lint_Markdown
+Website Page Linting:
+  extends: .Lint_Markdown_Pages
 
 
-Main Site:
+Website:
   extends: .MKDocs_Build
-  needs: [ 'Lint Markdown' ]
+  needs: [ 'Website Page Linting' ]
 
 
 pages:
@@ -21,8 +21,8 @@ pages:
   variables:
     GIT_STRATEGY: none
   script:
-    - mv "$CI_PROJECT_DIR/artifacts/build/Main Site/build" public
-  needs: [ 'Main Site' ]
+    - mv "$CI_PROJECT_DIR/artifacts/build/Website/build" public
+  needs: [ 'Website' ]
   environment: 
     name: staging
     url: $CI_PAGES_URL/projects/gitlab-ci/

validation/CHANGELOG.md

@@ -1,19 +0,0 @@
-# Changelog
-
-2023-05-14 15:45:30 +0930 [8581981](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/8581981a43c31d6903865f067fa3f77adae949e5) - fix(markdown_lint): fix search paths  
-2023-05-14 12:44:08 +0930 [cf10e28](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/cf10e289d21a5cc529bbe7effb189aab65875510) - fix(markdown_lint): enable job for md in sub folders  
-2022-01-31 10:19:16 +0930 [d75e959](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/d75e95998b4a195cfcc36683ffa6f058bf7b05be) - feat(markdown_lint): artifact locations to be hard set  
-2022-01-31 10:15:54 +0930 [8391bf6](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/8391bf659bf5dd39edf31205a68c699851e78be3) - fix(markdown_lint): remove quotes from search path variable.  
-2022-01-25 00:08:05 +0000 [ce1cc01](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/ce1cc017e26ff7f6cee586cc7d98e4d292275672) - build(version): bump version 0.6.0 → 0.6.1rc0  
-2022-01-25 09:23:42 +0930 [e0402ec](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/e0402ecfb2ab662a74bb70df7937b02576d5e41b) - fix(lint_markdown): ensure the correct path for the job directory is used  
-2022-01-24 06:33:24 +0000 [46cc1fb](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/46cc1fbb6a878e485af39e679b5184a9912c2e7f) - build(version): bump version 0.5.0 → 0.6.0  
-2022-01-24 05:14:54 +0000 [b6dcb47](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/b6dcb47b1d1831784d36f482fd99c0ce5e56f088) - docs(markdown_lint): removed no longer needed requirement.  
-2022-01-23 06:53:57 +0000 [fd48316](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/fd48316ae763282fc106b7da184c05b35d9ae052) - docs(markdown_lint): updated docs on how to use and view rules.  
-2022-01-23 06:48:42 +0000 [9ab336f](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/9ab336fbddd6cba1d29c5a001ab52772ed4554b6) - feat(markdown_lint): include junit configuration file '.markdownlint-cli2.jsonc' in ci job.  
-2022-01-23 06:39:23 +0000 [e46dc57](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/e46dc57b1643d6fd7c393bcf8b7d1d77bd2096c8) - chore(markdown_lint): add empty junit test file.  
-2022-01-23 03:21:43 +0000 [2115964](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/21159643176249cbc33df3a655df90267d64bc3b) - chore: review fixes.  
-2022-01-23 03:19:58 +0000 [e0d8885](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/e0d8885d52319a6188c779e80c2064b773721184) - ci(artifacts): markdown lint and mkdocs build artifacts to expire after 24 hours  
-2022-01-23 11:05:07 +0930 [6363ea3](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/6363ea377cd008bbc839e6f4ee4fca337b77bc19) - docs(markdown_lint): completed the job docs.  
-2022-01-23 10:43:54 +0930 [6383cde](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/6383cde3bf9985b2cb43908bc2486d1dc67b7026) - docs(markdown_lint): initial adding of the docs  
-2022-01-23 10:03:02 +0930 [954aa28](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/954aa28dbf1073be05a3dd6d13da818a0bc7cb4e) - feat(validation): Added a Markdown linting validation job.  
-2022-01-23 09:52:30 +0930 [bc67e93](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/bc67e939faf0b3d2eac05eae7edf297c81e55739) - chore: initial add of build and validation jobs for mkdocs and markdown linting