Cleaned up and improved

Author: rimi-itk

.github/workflows/documentation.yaml

@@ -3,7 +3,7 @@ on: pull_request
 name: Review
 
 env:
-  COMPOSE_USER: root
+  COMPOSE_USER: runner
 
 jobs:
   check-github-actions-documentation:
@@ -12,20 +12,34 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: arduino/setup-task@v2
+        # https://github.com/arduino/setup-task/tree/56d0cc033e3cecc5f07a291fdd39f29388d21800?tab=readme-ov-file#repo-token
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      # https://github.com/mxschmitt/action-tmate?tab=readme-ov-file#manually-triggered-debug
+      # Enable tmate debugging if debug logging is enabled (cf.
+      # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#runner-context)
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: 1 == runner.debug
+
       - run: |
           task github-actions:documentation:update
+
       # Check that documentation has not changed.
       - run: |
-          git diff --exit-code docs/github-action-templates.md
+          task github-actions:documentation:diff
 
   check-github-actions-template-headers:
     runs-on: ubuntu-latest
     name: Check that Github Actions template headers are up to date
     steps:
       - uses: actions/checkout@v4
       - uses: arduino/setup-task@v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
       - run: |
-          task github-actions:update-headers --yes
+          task github-actions:template-headers:update --yes
       # Check that files hav not changed.
       - run: |
           git diff --exit-code github/workflows/

.markdownlint.jsonc

@@ -0,0 +1,19 @@
+// markdownlint-cli configuration file (cf. https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration)
+{
+  "default": true,
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
+  "line-length": {
+    "line_length": 120,
+    "code_blocks": false,
+    "tables": false
+  },
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
+  "no-duplicate-heading": {
+    "siblings_only": true
+  },
+  // https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections#creating-a-collapsed-section
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
+  "no-inline-html": {
+    "allowed_elements": ["details", "summary"]
+  }
+}

.markdownlint.jsonc

@@ -0,0 +1,8 @@
+# https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#ignoring-files
+vendor/
+node_modules/
+LICENSE.md
+# Drupal
+web/*.md
+web/core/
+web/*/contrib/

.markdownlintignore

@@ -2,6 +2,9 @@
 
 version: '3'
 
+includes:
+  github-actions: ./task/Tasfile.github-actions.yml
+
 vars:
   GITHUB_ACTIONS_TEMPLATES_HEADER: |
     # Github Actions templates
@@ -16,63 +19,11 @@ vars:
   GITHUB_ACTIONS_TEMPLATES_FOOTER: |
 
 tasks:
-  github-actions:documentation:update:
-    desc: "Update GitHub Actions template documentation"
-    sources:
-      - github/workflows/*.yaml
-    generates:
-      - docs/github-action-templates.md
-    cmds:
-      - mkdir -p docs
-      - |
-        echo '{{.GITHUB_ACTIONS_TEMPLATES_HEADER}}' > docs/github-action-templates.md
-      - |
-        for f in github/workflows/*.yaml; do
-          echo "" >> docs/github-action-templates.md
-          echo "---" >> docs/github-action-templates.md
-          echo "" >> docs/github-action-templates.md
-
-          echo "[$f]($f)" >> docs/github-action-templates.md
-
-          cat "$f" | grep -E '^###( |$)' | sed -E -e 's/^### ?//' >> docs/github-action-templates.md
-        done
-      - |
-        echo "{{.GITHUB_ACTIONS_TEMPLATES_FOOTER}}" >> docs/github-action-templates.md
-      # Link to clean up.
-      - task lint:markdown -- docs/github-action-templates.md
-
-  github-actions:update-headers:
-    prompt: "Updating headers may break things, so check result afterwards. Really update headers?"
-    desc: "Update headers in GitHub Actions templates"
-    cmds:
-      - |
-        for f in github/workflows/*.yaml; do
-          echo "$f"
-          # If file starts with `# ` …
-          if [[ $(head --lines=1 "$f") =~ "^# " ]]; then
-            # … replace the header.
-            # This is done by deleting all lines from the top of the file to a blank line.
-            docker run --rm --volume=$PWD:/app --user ${COMPOSE_USER:-deploy} itkdev/php8.3-fpm:latest sed -i '1,/^$/d' "$f"
-          fi
-
-          # Write header and file into temporary file.
-          (
-          echo "# Do not edit this file! Make a pull request on changing";
-          echo "# $f in";
-          echo "# https://github.com/itk-dev/devops_itkdev-docker if need be.";
-          echo "";
-          cat "$f"
-          ) > "$f.tmp"
-          # Replace original file with temporary file.
-          mv "$f.tmp" "$f"
-        done
-
   lint:markdown:
     desc: "Lint Markdown"
     cmds:
-      # I cannot get itkdev/markdownlint to work as expected, i.e. as peterdavehello/markdownlint does …
-      - docker run --rm --volume "$PWD":/md peterdavehello/markdownlint markdownlint {{.GLOB}} --fix
-      - docker run --rm --volume "$PWD":/md peterdavehello/markdownlint markdownlint {{.GLOB}}
+      - '[[ -n "$SKIP_FIX" ]] || docker run --rm --volume "$PWD":/md itkdev/markdownlint markdownlint {{.GLOB}} --fix'
+      - docker run --rm --volume "$PWD":/md itkdev/markdownlint markdownlint {{.GLOB}}
     vars:
       # We use a block scalar (https://yaml-multiline.info/#block-scalars) here to make escaping (a little) easier.
       GLOB: >-

.markdownlintignore

@@ -0,0 +1,17 @@
+<?php
+// https://github.com/VincentLanglet/Twig-CS-Fixer/blob/main/docs/configuration.md#configuration-file
+
+$finder = new TwigCsFixer\File\Finder();
+
+if (glob('web/*/custom/*/templates')) {
+  $finder->in('web/*/custom/*/templates');
+}
+// Include sub-modules or sub-themes
+if (glob('web/*/custom/*/*/templates')) {
+  $finder->in('web/*/custom/*/*/templates');
+}
+
+$config = new TwigCsFixer\Config\Config();
+$config->setFinder($finder);
+
+return $config;