全ての workflow に name: を設定しつつ、reusable workflow のドキュメントを改善する

[masutaka]

変更概要

(1) 見栄えが良くないので、全ての workflow に name: を設定しました。また、my_*.yml の workflow は My prefix を付けました（参考）。

🔗 https://github.com/route06/actions/actions

(2) ドキュメント中の usage にも name: を設定し、見栄えの悪さがユーザーに伝播しないようにしました。

(3) 全体的にドキュメントを改善しました。

レビュー方法

f47f04d 以外は、変更後のファイルを確認するとレビューしやすいかと思います。

• add_assignee_to_pr.yml
• calc_next_date.yml
• codeql.yml
• codeql_core.yml
• create_gh_discussion.yml
• get_last_discussion_url.yml
• gh_discussion_comment_to_slack.yml
• notify_slack_on_ci_failed.yml

やらなかったこと

my_test.yml に以下のテストを導入し、(1)(2) が壊れた時に気付けるようにしたらどうだろう？と思いました。しかし、維持コストに見合わないと感じて止めました。

Details

diff --git a/.github/workflows/my_test.yml b/.github/workflows/my_test.yml
index dfdb203..b4fc7c7 100644
--- a/.github/workflows/my_test.yml
+++ b/.github/workflows/my_test.yml
@@ -32,3 +32,72 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ls-lint/action@1887e6c0e7f2dfa81a2d67591f0eb7782720026f # v2.2.3
+
+  own-lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    defaults:
+      run:
+        shell: bash
+        working-directory: .github/workflows
+    steps:
+      - uses: actions/checkout@v4
+      - name: "List workflows missing '^name:' line"
+        run: |
+          REGEXP='^name:'
+          missing_files=()
+
+          for file in *.yml; do
+            if ! grep -lq "$REGEXP" $file; then
+              missing_files+=("$file")
+            fi
+          done
+
+          if [ "${#missing_files[@]}" = 0 ]; then
+            echo "All workflows contain the '$REGEXP' line."
+            exit 0
+          fi
+
+          echo "The following workflows are missing the '$REGEXP' line:"
+          for file in "${missing_files[@]}"; do
+            echo "$file"
+          done
+
+          exit 1
+
+      - name: "List workflows missing '^# name:' line"
+        run: |
+          REGEXP='^# name:'
+
+          IGNORE_FILES=(
+            "codeql_core.yml"
+            "my_*.yml"
+          )
+
+          missing_files=()
+
+          for file in *.yml; do
+            # Skip ignored files
+            for ignore in "${IGNORE_FILES[@]}"; do
+              if [[ "$file" == $ignore ]]; then
+                echo "ignore: $file"
+                continue 2
+              fi
+            done
+
+            if ! grep -lq "$REGEXP" $file; then
+              missing_files+=("$file")
+            fi
+          done
+
+          if [ "${#missing_files[@]}" = 0 ]; then
+            echo "All workflows contain the '$REGEXP' line."
+            exit 0
+          fi
+
+          echo "The following workflows are missing the '$REGEXP' line:"
+          for file in "${missing_files[@]}"; do
+            echo "$file"
+          done
+
+          exit 1

[MH4GF]

感謝です 🙌🏻

[masutaka]

(1) 見栄えが良くないので、全ての workflow に name: を設定しました。また、my_*.yml の workflow は My prefix を付けました（参考）。

きれいになりました。

🔗 https://github.com/route06/actions/actions

📝 一番上はマージされなかった #37 の履歴。今の設定だと履歴を 90 日保持するので、9/14 くらいに消えると思う。