Merge pull request #574 from hhiroshell/notice-i18n-tasks

Introduce a GitHub Action That Sends a Message to a PR to Notify i18n Tasks.

Author: Lian Li

.github/workflows/deep-diff.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+# This script lists files that have been added or edited under a specified directory,
+# including the targets of any symlinks.
+
+set -e
+
+if [ "$#" -ne 3 ]; then
+    echo "The number of arguments must be 3." >&2
+    echo "Usage: ./deep-diff.sh [path] [commit-before] [commit-after]" >&2
+    exit 1
+fi
+
+git diff --name-only "$2" "$3" "$1"
+
+# Differences in targets of symbolic links.
+symlinks=$(find "$1" -type l)
+for l in ${symlinks}; do
+    linktarget=$(readlink -f "${l}")
+    git diff --name-only "$2" "$3" "$(realpath --relative-to=. "${linktarget}")"
+done

.github/workflows/notice-i18n-tasks.yml

@@ -0,0 +1,42 @@
+name: Notice i18n Tasks
+on:
+  pull_request_target:
+    types:
+    - opened
+    - reopened
+    - synchronize
+
+jobs:
+  notice-i18n-tasks:
+    runs-on: ubuntu-latest
+
+    permissions:
+      pull-requests: write
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        repository: ${{ github.event.pull_request.head.repo.full_name }}
+        ref: ${{ github.event.pull_request.head.ref }}
+        fetch-depth: 0
+
+    - name: Check diffs
+      id: check-diffs
+      run: |
+        updated_files="$(.github/workflows/deep-diff.sh website/content/en ${{ github.sha }} ${{ github.event.pull_request.head.sha }})"
+        echo "${updated_files}" # for debugging
+        echo "count=$(echo $updated_files | grep -v '^$' | wc -l)" >> $GITHUB_OUTPUT
+
+    - name: Send notice on the issue
+      if: steps.check-diffs.outputs.count > 0
+      uses: thollander/actions-comment-pull-request@v2
+      with:
+        comment_tag: i18n-notice
+        message: |
+          ### Action Required
+          You are adding or updating English content so please take the following actions for other languages.
+          - If you add new content under `website/content/en` or targets of the symbolic links in the same directory, please replicate it in the corresponding directories of all other languages. (e.g. If you create `website/content/en/blog/new-post.md`, you should copy it to `website/content/ja/blog/new-post.md`, etc.)
+          - If you update the content in the same location, please perform the following actions for the corresponding content in other languages.
+            - If the content has not been translated yet, replace the files with the updated English version.
+            - If the content has already been translated, include a note suggesting that users check the English page for the most recent updates.