Merge pull request #6629 from TicClick/extend-yamllint-ci

Run yamllint for regular articles/newsposts

.github/scripts/ci/run_yamllint.py

@@ -0,0 +1,91 @@
+import argparse
+import os
+import sys
+import typing
+
+import yamllint.cli
+import yamllint.config
+import yamllint.linter
+
+FRONT_MATTER_DELIMITER = "---"
+MARKDOWN_EXTENSION = ".md"
+
+
+def front_matter(fileobj: typing.TextIO, filepath: str) -> str:
+    delimiters = 0
+    lines = []
+    for line in fileobj:
+        if line.split("#")[0].strip() == FRONT_MATTER_DELIMITER:
+            delimiters += 1
+        # Stop on second delimiter, or when it's clear there won't be front matter at all
+        if delimiters == 2 or line.startswith("# "):
+            break
+        lines.append(line)
+
+    if delimiters == 0:
+        return ""
+    if delimiters == 2:
+        return "".join(lines)
+    raise ValueError(f"The file {filepath} has malformed front matter")
+
+
+def read_yaml(filepath: str):
+    with open(filepath, "r") as fd:
+        if filepath.endswith(MARKDOWN_EXTENSION):
+            return front_matter(fd, filepath)
+        else:
+            return fd.read()
+
+
+def file_iterator(roots: list, config: yamllint.config.YamlLintConfig):
+    for item in roots:
+        if os.path.isdir(item):
+            for root, _, filenames in os.walk(item):
+                for f in filenames:
+                    filepath = os.path.join(root, f)
+                    if (
+                        not config.is_file_ignored(filepath) and
+                        (config.is_yaml_file(filepath) or filepath.endswith(MARKDOWN_EXTENSION))
+                    ):
+                        yield filepath
+        elif os.path.isfile(item):
+            yield item
+
+
+def parse_args(args: list):
+    parser = argparse.ArgumentParser(
+        description="Check YAML files and front matter of the Markdown documents for common mistakes"
+    )
+    parser.add_argument("--config", help="path to the yamllint config")
+    parser.add_argument(
+        "--target", nargs="+", default=(".",),
+        help="files or directories to lint (by default, assumes current working directory)"
+    )
+    parser.add_argument("--format", choices=("parsable", "standard", "colored", "github", "auto"),
+        default="colored", help="output format (see yamllint docs for details)"
+    )
+    return parser.parse_args(args)
+
+
+def main():
+    args = parse_args(sys.argv[1:])
+    config = yamllint.config.YamlLintConfig(file=os.path.expanduser(args.config))
+
+    max_level = 0
+    for path in file_iterator(args.target, config):
+        try:
+            path = path[2:] if path.startswith('./') else path
+            payload = read_yaml(path)
+            problems = yamllint.linter.run(payload, config, path)
+        except EnvironmentError as e:
+            print(e, file=sys.stderr)
+            sys.exit(-1)
+        current_level = yamllint.cli.show_problems(problems, path, args_format=args.format, no_warn=False)
+        max_level = max(max_level, current_level)
+
+    if max_level == yamllint.linter.PROBLEM_LEVELS["error"]:
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/continuous-integration.yml

@@ -33,7 +33,7 @@ jobs:
 
           # set up sparse checkout
           git sparse-checkout init
-          git sparse-checkout set '**/*.md' '**/.remark*' '**/*.json' '**/*.yaml'
+          git sparse-checkout set '**/*.md' '**/.remark*' '**/*.json' '**/*.yaml' '.github/scripts'
 
           # fetch the merge commit ref
           git -c protocol.version=2 fetch --no-tags --prune --progress --depth=2 origin +${GITHUB_SHA}:refs/remotes/origin/${BRANCH}
@@ -79,10 +79,15 @@ jobs:
         # stdout is discarded (remark prints files being checked there)
         run: git diff --diff-filter=d --name-only ${{ github.sha }}^ ${{ github.sha }} '*.md' | xargs -d '\n' npx remark -qf --no-stdout --silently-ignore --report=vfile-reporter-position --color
 
-      - name: run yamllint on all yaml files
-        uses: ibiqlik/[email protected]
+      - name: setup Python
+        uses: actions/setup-python@v2
         with:
-          config_file: .yamllint.yaml
+          python-version: "3.x"
+
+      - name: setup and run yamllint on .yaml and .md files
+        run: |
+          pip install yamllint
+          python .github/scripts/ci/run_yamllint.py --config .yamllint.yaml
 
       - name: check if translations are marked as outdated
         shell: bash