More clean up

rimi-itk · rimi-itk · commit 8985de33e115 · 2025-04-08T10:02:28.000+02:00
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -3,7 +3,7 @@
 version: '3'
 
 includes:
-  github-actions: ./task/Tasfile.github-actions.yml
+  github-actions: ./task/Taskfile.github-actions.yml
 
 vars:
   GITHUB_ACTIONS_TEMPLATES_HEADER: |
diff --git a/config/drupal/twig/.twig-cs-fixer.dist.php b/config/drupal/twig/.twig-cs-fixer.dist.php
@@ -2,14 +2,10 @@
 // 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');
-}
+// Check all files …
+$finder->in(__DIR__);
+// … that are not ignored by VSC
+$finder->ignoreVCSIgnored(true);
 
 $config = new TwigCsFixer\Config\Config();
 $config->setFinder($finder);
diff --git a/config/symfony/twig/.twig-cs-fixer.dist.php b/config/symfony/twig/.twig-cs-fixer.dist.php
@@ -2,7 +2,10 @@
 // https://github.com/VincentLanglet/Twig-CS-Fixer/blob/main/docs/configuration.md#configuration-file
 
 $finder = new TwigCsFixer\File\Finder();
-$finder->in('templates');
+// Check all files …
+$finder->in(__DIR__);
+// … that are not ignored by VSC
+$finder->ignoreVCSIgnored(true);
 
 $config = new TwigCsFixer\Config\Config();
 $config->setFinder($finder);
diff --git a/docs/github-actions-templates.md b/docs/github-actions-templates.md
@@ -1,6 +1,6 @@
 <!-- DO NOT EDIT THIS FILE!
 
-It was automatically created by task/github-documentation-update.sh at Fri Apr  4 13:49:36 CEST 2025.
+It was automatically created by task/scripts/github-documentation-update at Tue Apr  8 10:02:13 CEST 2025.
 -->
 # Github Actions templates
 
@@ -51,13 +51,13 @@ Validates composer.json and checks that it's normalized.
 
 ---
 
-[github/workflows/drupal-php.yaml](github/workflows/drupal-php.yaml)
+[github/workflows/drupal/php.yaml](github/workflows/drupal/php.yaml)
 
 Drupal PHP
 
 ---
 
-[github/workflows/drupal-site.yaml](github/workflows/drupal-site.yaml)
+[github/workflows/drupal/site.yaml](github/workflows/drupal/site.yaml)
 
 ### Drupal
 
@@ -97,15 +97,15 @@ Styles (CSS and SCSS)
 
 ---
 
-[github/workflows/symfony-php.yaml](github/workflows/symfony-php.yaml)
+[github/workflows/symfony/php.yaml](github/workflows/symfony/php.yaml)
 
 Symfony PHP
 
 ---
 
 [github/workflows/twig.yaml](github/workflows/twig.yaml)
 
-### Twigt
+### Twig
 
 Validates Twig files
 
diff --git a/github/workflows/drupal/php.yaml b/github/workflows/drupal/php.yaml
diff --git a/github/workflows/drupal/site.yaml b/github/workflows/drupal/site.yaml
diff --git a/github/workflows/symfony/php.yaml b/github/workflows/symfony/php.yaml
diff --git a/github/workflows/twig.yaml b/github/workflows/twig.yaml
@@ -2,7 +2,7 @@
 # github/workflows/twig.yaml in
 # https://github.com/itk-dev/devops_itkdev-docker if need be.
 
-### ### Twigt
+### ### Twig
 ###
 ### Validates Twig files
 ###
diff --git a/task/Taskfile.github-actions.yml b/task/Taskfile.github-actions.yml
@@ -6,7 +6,7 @@ tasks:
     cmds:
       - task: run-script
         vars:
-          SCRIPT: task/github-documentation-update.sh
+          SCRIPT: github-documentation-update
       - SKIP_FIX=1 task lint:markdown -- docs/github-actions-templates.md
 
   documentation:diff:
@@ -45,7 +45,7 @@ tasks:
           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"
+            docker run --rm --volume=$PWD:/app --user ${COMPOSE_USER:-deploy} itkdev/php8.4-fpm:latest sed -i '1,/^$/d' "$f"
           fi
 
           # Write header and file into temporary file.
@@ -66,7 +66,7 @@ tasks:
     cmds:
       - task: run-script
         vars:
-          SCRIPT: task/github-actions-link.sh
+          SCRIPT: github-actions-link
     silent: true
 
   show:
@@ -78,7 +78,7 @@ tasks:
   run-script:
     internal: true
     cmds:
-      - docker run --rm --volume "$PWD:/app" --user ${COMPOSE_USER:-deploy} itkdev/php8.3-fpm:latest {{.SCRIPT}}
+      - docker run --rm --volume "$PWD:/app" --user ${COMPOSE_USER:-deploy} itkdev/php8.4-fpm:latest task/scripts/{{.SCRIPT}}
     requires:
       vars:
         - SCRIPT
diff --git a/task/docs/github-actions-templates.md b/task/docs/github-actions-templates.md
@@ -0,0 +1,24 @@
+<!-- DO NOT EDIT THIS FILE!
+
+It was automatically created by task/scripts/github-documentation-update.sh at Tue Apr  8 09:33:44 CEST 2025.
+-->
+# Github Actions templates
+
+This repository contains a number of [GitHub Actions](https://docs.github.com/en/actions) workflow template files that
+are copied to a project when running `itkdev-docker-compose template:install`. Any changes to the workflows should be
+made in [this repository](https://github.com/itk-dev/devops_itkdev-docker) and then the project template must be updated
+to match the new templates.
+
+## Naming conventions
+
+* Named after what a tool is concerned with, not how it's concerned with it.
+* Some configuration based on template type (drupal, symfony)
+
+## Templates
+
+---
+
+[github/workflows/*.yaml](github/workflows/*.yaml)
+
+
+---
diff --git a/task/links.png b/task/links.png
diff --git a/task/scripts/github-actions-link b/task/scripts/github-actions-link
@@ -3,15 +3,15 @@ set -o errexit -o errtrace -o noclobber -o nounset -o pipefail
 IFS=$'\n\t'
 
 script_dir=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
-project_dir=$(cd "$(dirname "$script_dir")" && pwd)
+project_dir=$(cd "$(dirname "$script_dir")/.." && pwd)
 
 cd "$project_dir" || exit
 
 # String type (drupal or symfony) from start of name
 function strip-project-type() {
   name=$1
 
-  if [[ "$name" =~ ^(drupal-|symfony-)(.+) ]]; then
+  if [[ "$name" =~ ^(drupal|symfony)/(.+) ]]; then
     name="${BASH_REMATCH[2]}"
   fi
 
@@ -36,19 +36,19 @@ for template_dir in templates/*; do
     exit 1
   fi
 
-  for f in github/workflows/*.yaml; do
-    file_name=$(basename "$f")
+  for f in $(find github/workflows/ -name '*.yaml' | sort); do
     source_file_name=''
-    if [[ "$file_name" =~ ^drupal- ]]; then
+    # Note: / is NOT a regex delimiter here, but an actual /, i.e. a directory separator.
+    if [[ "$f" =~ /drupal/ ]]; then
       if [[ "$project_type" == "drupal" ]]; then
-        source_file_name="$file_name"
+        source_file_name="$(basename $(dirname "$f"))/$(basename "$f")"
       fi
-    elif [[ "$file_name" =~ ^symfony- ]]; then
+    elif [[ "$f" =~ /symfony/ ]]; then
       if [[ "$project_type" == "symfony" ]]; then
-        source_file_name="$file_name"
+        source_file_name="$(basename $(dirname "$f"))/$(basename "$f")"
       fi
     else
-      source_file_name="$file_name"
+      source_file_name=$(basename "$f")
     fi
 
     if [[ -n "$source_file_name" ]]; then
@@ -82,19 +82,3 @@ for template_dir in templates/*; do
   find "$template_dir" -type l -ls
   echo
 done
-
-# Generate Mermaid graph showing links
-mermaid_file_name="$script_dir/links.mermaid"
-
-cat >| "$mermaid_file_name" <<'EOF'
-graph TD
-EOF
-for link in $(find templates -type l); do
-  link_id=$(base64 <<< $link)
-  link_id=${link_id//=}
-
-  target=$(readlink $link)
-  target_id=$(base64 <<< $target)
-  target_id=${target_id//=}
-  echo "  $link_id[$link] --> $target_id[$target]" >> "$mermaid_file_name"
-done
diff --git a/task/scripts/github-documentation-update b/task/scripts/github-documentation-update
@@ -3,14 +3,14 @@
 # IFS=$'\n\t'
 
 script_dir=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
-project_dir=$(cd "$(dirname "$script_dir")" && pwd)
+project_dir=$(cd "$(dirname "$script_dir")/.." && pwd)
 
 cd "$project_dir" || exit
 
-template_file_name="$script_dir/github-actions-templates.md"
+template_file_name="$script_dir/../templates/github-actions-templates.md"
 
 place_holder="insert:templates:here"
-place_holder_line=$(grep --line-number --no-filename "$place_holder" task/github-actions-templates.md | cut -d: -f1)
+place_holder_line=$(grep --line-number --no-filename "$place_holder" "$template_file_name" | cut -d: -f1)
 
 if [[ -z "$place_holder_line" ]]; then
   (>&2 echo "Cannot find placeholder $place_holder in $template_file_name")
@@ -34,7 +34,7 @@ EOF
 # Template content before place holder
 head --lines="$((place_holder_line-1))" "$template_file_name" >> "$output_file_name"
 
-for f in github/workflows/*.yaml; do
+for f in $(find github/workflows/ -name '*.yaml' | sort); do
   # Separator
   cat >> "$output_file_name" <<EOF
 
diff --git a/task/templates/github-actions-templates.md b/task/templates/github-actions-templates.md
diff --git a/templates/drupal-10/.github/workflows/php.yaml b/templates/drupal-10/.github/workflows/php.yaml
@@ -1 +1 @@
-../../../../github/workflows/drupal-php.yaml
+../../../../github/workflows/drupal/php.yaml
diff --git a/templates/drupal-10/.github/workflows/site.yaml b/templates/drupal-10/.github/workflows/site.yaml
@@ -1 +1 @@
-../../../../github/workflows/drupal-site.yaml
+../../../../github/workflows/drupal/site.yaml
diff --git a/templates/drupal-10/phpcs.xml b/templates/drupal-10/phpcs.xml
@@ -0,0 +1 @@
+../../config/drupal/php/phpcs.xml
diff --git a/templates/drupal-7/.github/workflows/php.yaml b/templates/drupal-7/.github/workflows/php.yaml
@@ -1 +1 @@
-../../../../github/workflows/drupal-php.yaml
+../../../../github/workflows/drupal/php.yaml
diff --git a/templates/drupal-7/.github/workflows/site.yaml b/templates/drupal-7/.github/workflows/site.yaml
@@ -1 +1 @@
-../../../../github/workflows/drupal-site.yaml
+../../../../github/workflows/drupal/site.yaml
diff --git a/templates/drupal-7/phpcs.xml b/templates/drupal-7/phpcs.xml
@@ -0,0 +1 @@
+../../config/drupal/php/phpcs.xml
diff --git a/templates/drupal-8/.github/workflows/php.yaml b/templates/drupal-8/.github/workflows/php.yaml
@@ -1 +1 @@
-../../../../github/workflows/drupal-php.yaml
+../../../../github/workflows/drupal/php.yaml
diff --git a/templates/drupal-8/.github/workflows/site.yaml b/templates/drupal-8/.github/workflows/site.yaml
@@ -1 +1 @@
-../../../../github/workflows/drupal-site.yaml
+../../../../github/workflows/drupal/site.yaml
diff --git a/templates/drupal-8/phpcs.xml b/templates/drupal-8/phpcs.xml
@@ -0,0 +1 @@
+../../config/drupal/php/phpcs.xml
diff --git a/templates/drupal-9/.github/workflows/php.yaml b/templates/drupal-9/.github/workflows/php.yaml
@@ -1 +1 @@
-../../../../github/workflows/drupal-php.yaml
+../../../../github/workflows/drupal/php.yaml
diff --git a/templates/drupal-9/.github/workflows/site.yaml b/templates/drupal-9/.github/workflows/site.yaml
@@ -1 +1 @@
-../../../../github/workflows/drupal-site.yaml
+../../../../github/workflows/drupal/site.yaml
diff --git a/templates/drupal-9/phpcs.xml b/templates/drupal-9/phpcs.xml
@@ -0,0 +1 @@
+../../config/drupal/php/phpcs.xml
diff --git a/templates/symfony-3/.github/workflows/php.yaml b/templates/symfony-3/.github/workflows/php.yaml
@@ -1 +1 @@
-../../../../github/workflows/symfony-php.yaml
+../../../../github/workflows/symfony/php.yaml
diff --git a/templates/symfony-3/php-cs-fixer.php.dist b/templates/symfony-3/php-cs-fixer.php.dist
@@ -0,0 +1 @@
+../../config/symfony/php/php-cs-fixer.php.dist
diff --git a/templates/symfony-4/.github/workflows/php.yaml b/templates/symfony-4/.github/workflows/php.yaml
@@ -1 +1 @@
-../../../../github/workflows/symfony-php.yaml
+../../../../github/workflows/symfony/php.yaml
diff --git a/templates/symfony-4/php-cs-fixer.php.dist b/templates/symfony-4/php-cs-fixer.php.dist
@@ -0,0 +1 @@
+../../config/symfony/php/php-cs-fixer.php.dist
diff --git a/templates/symfony-6/.github/workflows/php.yaml b/templates/symfony-6/.github/workflows/php.yaml
@@ -1 +1 @@
-../../../../github/workflows/symfony-php.yaml
+../../../../github/workflows/symfony/php.yaml
diff --git a/templates/symfony-6/php-cs-fixer.php.dist b/templates/symfony-6/php-cs-fixer.php.dist
@@ -0,0 +1 @@
+../../config/symfony/php/php-cs-fixer.php.dist
