Introduced documentation workflow

Author: mikouaj

.github/workflows/documentation.yml

@@ -0,0 +1,46 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Documentation checks
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  linting:
+    name: Documentation linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+      - name: Check license headers
+        run: python3 scripts/license_header_check.py $GITHUB_WORKSPACE
+      - name: Markdown linter
+        uses: avto-dev/markdown-lint@v1
+        with:
+          config: '.markdownlint.yml'
+          args: '**/*.md'
+      - name: Markdown links
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          config-file: '.mlc_config.json'
+          base-branch: main

.markdownlint.yml

@@ -0,0 +1,17 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+MD013:
+  line_length: 100
+  tables: false

.mlc_config.json

@@ -0,0 +1,10 @@
+{
+    "ignorePatterns": [
+      {
+        "pattern": "^http://example.net"
+      },
+      {
+        "pattern": "^https://docs.github.com"
+      }
+    ]
+}

scripts/license_header_check.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python3
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+'''Check that boilerplate is present in relevant files.
+This tools offers a simple way of ensuring that the required boilerplate header
+is present in files with specific extensions. Files can be excluded by using a
+special comment anywhere in the file.
+The interface is purposefully simple and only supports passing one or more
+folder paths as arguments, as this tool is designed to be run in CI pipelines
+triggered by pull requests.
+'''
+
+import os
+import re
+import sys
+
+_EXCLUDE_DIRS = ('.git', '.terraform')
+_EXCLUDE_RE = re.compile(r'# skip boilerplate check')
+_EXCLUDE_FILES = {}
+_MATCH_FILES = ('Dockerfile', '.py', '.sh', '.tf', '.yaml', '.yml', '.go', '.rego')
+_MATCH_STRING = (r'^\s*([#\*]|[/]{2})\sCopyright [0-9]{4} Google LLC$\s+([#\*]|[/]{2})\s+'
+                 r'([#\*]|[/]{2})\sLicensed under the Apache License, Version 2.0 '
+                 r'\(the "License"\);\s+')
+_MATCH_RE = re.compile(_MATCH_STRING, re.M)
+
+def main(base_dirs):
+  "Cycle through files in base_dirs and check for the Apache 2.0 boilerplate."
+  errors, warnings = [], []
+  for dir in base_dirs:
+    for root, dirs, files in os.walk(dir):
+      dirs[:] = [d for d in dirs if d not in _EXCLUDE_DIRS]
+      for fname in files:
+        if fname in _MATCH_FILES or os.path.splitext(fname)[1] in _MATCH_FILES:
+          fpath = os.path.abspath(os.path.join(root, fname))
+          content = open(fpath).read()
+          relPath = os.path.relpath(fpath, dir)
+          if relPath in _EXCLUDE_FILES:
+            continue
+          if _EXCLUDE_RE.search(content):
+            continue
+          try:
+            if not _MATCH_RE.search(content):
+              errors.append(fpath)
+          except (IOError, OSError):
+            warnings.append(fpath)
+  if warnings:
+    print('The following files cannot be accessed:')
+    print('\n'.join(' - {}'.format(s) for s in warnings))
+  if errors:
+    print('The following files are missing the license boilerplate:')
+    print('\n'.join(' - {}'.format(s) for s in errors))
+    sys.exit(1)
+
+
+if __name__ == '__main__':
+  if len(sys.argv) < 2:
+    raise SystemExit('No directory to check.')
+  main(sys.argv[1:])