GitHub super linterの利用をやめる (#397)

* npm-run-allをインストール * textlintを実行するスクリプトの名前を更新 * lintを全件実行するスクリプトを追加 * textlintを実行するワークフローの実装を見直し * markdownlint-cliをインストール * markdownlintの実行スクリプトを登録 * markdownlintの実行をワークフローに組み込み * yamllintのバージョンを明記 * gitignoreに記載のファイルをyamllintの検査対象から除外 * yamllintの実行スクリプトをワークフローに追加 * GitHub super linterの処理を削除 * チェックアウトのアクションをv4に更新 * チェックアウトの深さを1に設定 * node.js v18のセットアップ処理を追加 * npm ciを使ってインストールするように変更 * ヘッダーの表示処理を移動 * ドキュメント開始のルールを無効に設定 * truthyのキーに対する検証を無効に設定 * yamllintの警告に対処
AlesInfiny · Nov 30, 2023 · 450ae56 · 450ae56
1 parent 6dab6ed
commit 450ae56
Show file tree

Hide file tree

Showing 9 changed files with 2,963 additions and 192 deletions.
diff --git a/.github/workflows/back-sample-pull-request-ut.yml b/.github/workflows/back-sample-pull-request-ut.yml
@@ -2,7 +2,7 @@
 # cSpell:ignore mikepenz dorny
 name: バックエンドサンプルAPに対するプルリクエスト時の単体テスト実行
 
-on:  # yamllint disable-line rule:truthy
+on:
   push:
     branches: [main]
     paths:

diff --git a/.github/workflows/build-and-release-documents.yml b/.github/workflows/build-and-release-documents.yml
@@ -2,7 +2,7 @@
 # cSpell:ignore endgroup fjogeleit markdownlint softprops textlintrc webapps
 name: ドキュメントのビルドとリリース
 
-on:  # yamllint disable-line rule:truthy
+on:
   push:
     branches: [main]
     tags:
@@ -35,82 +35,85 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ブランチのチェックアウト
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 1
 
-      - name: Linter の処理開始
-        run: |
-          echo '# Linter Result :newspaper:' >> $GITHUB_STEP_SUMMARY
+      - name: Node.js のセットアップ
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
 
-      - name: GitHub Super Linter の実行
-        id: execute_super_linter
-        continue-on-error: true
-        uses: github/super-linter/slim@v4
-        env:
-          VALIDATE_ALL_CODEBASE: true
-          DEFAULT_BRANCH: main
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          FILTER_REGEX_INCLUDE: "documents/.*"
-          LINTER_RULES_PATH: /
-          MARKDOWN_CONFIG_FILE: '.markdownlint.yaml'
-          VALIDATE_MARKDOWN: true
-          VALIDATE_YAML: true
-          YAML_CONFIG_FILE: '.yaml-lint.yml'
-
-      - name: GitHub Super Linter の結果表示
+      - name: npm パッケージのインストール
+        run: npm ci
+
+      - name: Python のセットアップ
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: pip パッケージのインストール
         run: |
-          echo '## GitHub Super linter' >> $GITHUB_STEP_SUMMARY
-          echo '::group::super-linter.log'
-          cat super-linter.log
-          echo '::endgroup::'
-          LINT_MSG=$(sed '/^$/d' super-linter.log | sed -n -e '/^------/,/^------/p' | sed -n -e '/^[^-]/p' | awk '!a[$0]++{print}')
-          if [ -n "$LINT_MSG" ]; then
-            echo ':warning: エラーまたは警告が見つかりました。' >> $GITHUB_STEP_SUMMARY
-            echo '```' >> $GITHUB_STEP_SUMMARY
-            echo "$LINT_MSG" >> $GITHUB_STEP_SUMMARY
-            echo '```' >> $GITHUB_STEP_SUMMARY
-          else
-            echo ':heavy_check_mark: 成功しました。' >> $GITHUB_STEP_SUMMARY
-          fi
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements.txt
+
+      - name: Linter の処理開始
+        run: echo '# Linter Result :newspaper:' >> $GITHUB_STEP_SUMMARY
 
-      - name: GitHub Super Linter の処理結果確認
-        if: ${{ steps.execute_super_linter.outcome == 'failure' }}
+      - name: Markdownlint の実行
+        id: run-markdownlint
+        continue-on-error: true
         run: |
-          exit 1
+          echo '## Markdownlint Result' >> $GITHUB_STEP_SUMMARY
+          npx markdownlint --config .markdownlint.yaml --ignore **/node_modules/** --output markdownlint-result.txt .
+          echo ':heavy_check_mark: Markdownlint に成功しました。' >> $GITHUB_STEP_SUMMARY
 
-      - name: npm パッケージのインストール
+      - name: Markdownlint 失敗時の結果表示
+        if: ${{ steps.run-markdownlint.outcome == 'failure' }}
         run: |
-          npm install
+          echo ':x: Markdownlint に失敗しました。  ' >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          cat markdownlint-result.txt >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          echo 'LINT_STATUS=Error' >> $GITHUB_ENV
 
-      - name: textlint の実行
-        id: execute_textlint
+      - name: yamllint の実行
+        id: run-yamllint
         continue-on-error: true
         run: |
-          echo '## textlint Result' >> $GITHUB_STEP_SUMMARY
-          npm run textlint-all > textlint-result.txt
-          echo ':heavy_check_mark: textlint に成功しました。' >> $GITHUB_STEP_SUMMARY
+          echo '## yamllint Result' >> $GITHUB_STEP_SUMMARY
+          yamllint --config-file .yaml-lint.yml --format standard . > yamllint-result.txt
+          echo ':heavy_check_mark: yamllint に成功しました。' >> $GITHUB_STEP_SUMMARY
 
-      - name: textlint 失敗時の結果表示
-        if: ${{ steps.execute_textlint.outcome == 'failure' }}
+      - name: yamllint 失敗時の結果表示
+        if: ${{ steps.run-yamllint.outcome == 'failure' }}
         run: |
-          echo '::group::textlint-result.txt'
-          cat textlint-result.txt
-          echo '::endgroup::'
-          echo ':x: textlint に失敗しました。  ' >> $GITHUB_STEP_SUMMARY
+          echo ':x: yamllint に失敗しました。  ' >> $GITHUB_STEP_SUMMARY
           echo '```' >> $GITHUB_STEP_SUMMARY
-          cat textlint-result.txt | sed -n -e '/problems\?/p' >> $GITHUB_STEP_SUMMARY
+          cat yamllint-result.txt >> $GITHUB_STEP_SUMMARY
           echo '```' >> $GITHUB_STEP_SUMMARY
-          exit 1
+          echo 'LINT_STATUS=Error' >> $GITHUB_ENV
 
-      - name: Python のセットアップ
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
+      - name: textlint の実行
+        run: |
+          echo '## textlint Result' >> $GITHUB_STEP_SUMMARY
+          npx textlint documents samples --output-file textlint-result.txt --format compact
+          if [ -f textlint-result.txt ]; then
+            echo ':x: textlint に失敗しました。  ' >> $GITHUB_STEP_SUMMARY
+            echo '```' >> $GITHUB_STEP_SUMMARY
+            cat textlint-result.txt >> $GITHUB_STEP_SUMMARY
+            echo '```' >> $GITHUB_STEP_SUMMARY
+            echo 'LINT_STATUS=Error' >> $GITHUB_ENV
+          else
+            echo ':heavy_check_mark: textlint に成功しました。' >> $GITHUB_STEP_SUMMARY
+          fi
+
+      - name: Lint 結果の確認
+        if: ${{ env.LINT_STATUS == 'Error' }}
+        run: exit 1
 
       - name: mkdocs のインストール
         run: |
-          python -m pip install --upgrade pip
           python -m pip install mkdocs
           python -m pip install mkdocs-material
           python -m pip install pymdown-extensions
@@ -198,13 +201,13 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: documents
-      
+
       - name: Azure に OIDC Login
         uses: azure/login@v1
         with:
           client-id: ${{ secrets.AZURE_CLIENT_ID }}
           tenant-id: ${{ secrets.AZURE_TENANT_ID }}
-          subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} 
+          subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
 
       - name: ステージング環境へのデプロイ
         uses: azure/webapps-deploy@v2

diff --git a/.github/workflows/remove-old-artifacts.yml b/.github/workflows/remove-old-artifacts.yml
@@ -1,7 +1,7 @@
 ---
 name: 古いアーティファクトの削除
 
-on:  # yamllint disable-line rule:truthy
+on:
   workflow_dispatch:
     inputs:
       target:

diff --git a/.github/workflows/samples-dressca-frontend.ci.yml b/.github/workflows/samples-dressca-frontend.ci.yml
@@ -5,7 +5,7 @@
 
 name: dressca-frontend CI
 
-on:  # yamllint disable-line rule:truthy
+on:
   pull_request:
     branches: [main]
     paths:

diff --git a/.yaml-lint.yml b/.yaml-lint.yml
@@ -5,6 +5,8 @@ yaml-files:
   - '*.yml'
   - '.yamllint'
 
+ignore-from-file: .gitignore
+
 rules:
   braces: enable
   brackets: enable
@@ -15,8 +17,7 @@ rules:
   comments-indentation:
     level: warning
   document-end: disable
-  document-start:
-    level: warning
+  document-start: disable
   empty-lines: enable
   empty-values: disable
   hyphens: enable
@@ -30,4 +31,5 @@ rules:
   quoted-strings: disable
   trailing-spaces: enable
   truthy:
+    check-keys: false
     level: warning
diff --git a/documents/mkdocs.yml b/documents/mkdocs.yml
@@ -34,9 +34,9 @@ nav:
                   - app-architecture/client-side-rendering/test/backend-application/index.md
                   - 単体テスト ( UT0 ): app-architecture/client-side-rendering/test/backend-application/unit-test.md
                   - 結合テスト ( ITa ): app-architecture/client-side-rendering/test/backend-application/integration-test.md
-#       - クックブック:
-#           - 目次: cook-book/index.md
-#           - 帳票印刷: cook-book/~~~
+  # - クックブック:
+      # - 目次: cook-book/index.md
+      # - 帳票印刷: cook-book/~~~
   - ガイド:
       - guidebooks/index.md
       - アプリケーション開発手順:
@@ -47,12 +47,12 @@ nav:
               - プロジェクトの雛型作成: guidebooks/how-to-develop/java/create-project.md
               - プロジェクトの共通設定: guidebooks/how-to-develop/java/common-project-settings.md
               - サブプロジェクトの個別設定: guidebooks/how-to-develop/java/sub-project-settings.md
-#           - Vue.js 編:
-#               - guidebooks/how-to-develop/vue-js/index.md
+          # - Vue.js 編:
+              # - guidebooks/how-to-develop/vue-js/index.md
           - ローカル開発環境の構築:
               - guidebooks/how-to-develop/local-environment/index.md
-#   - サンプル解説:
-#       - samples/index.md
+  # - サンプル解説:
+      # - samples/index.md
   - 利用規約:
       - terms/index.md