[DO NOT MERGE][ci] add yaml files linter to pre-commit hook

.github/workflows/cuda.yml

@@ -3,10 +3,10 @@ name: CUDA Version
 on:
   push:
     branches:
-    - master
+      - master
   pull_request:
     branches:
-    - master
+      - master
   # Run manually by clicking a button in the UI
   workflow_dispatch:
     inputs:
@@ -43,9 +43,12 @@ jobs:
                 software-properties-common
             # set up nvidia-docker
             curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
-            sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" -y
+            sudo add-apt-repository -y \
+              "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
             curl -sL https://nvidia.github.io/nvidia-docker/gpgkey | sudo apt-key add -
-            curl -sL https://nvidia.github.io/nvidia-docker/$(. /etc/os-release;echo $ID$VERSION_ID)/nvidia-docker.list | sudo tee /etc/apt/sources.list.d/nvidia-docker.list
+            curl -sL \
+              https://nvidia.github.io/nvidia-docker/$(. /etc/os-release;echo $ID$VERSION_ID)/nvidia-docker.list \
+            | sudo tee /etc/apt/sources.list.d/nvidia-docker.list
             sudo apt-get update
             sudo apt-get install --no-install-recommends -y \
                 containerd.io \
@@ -58,6 +61,7 @@ jobs:
         run: |
           exit 0
   test:
+    # yamllint disable-line rule:line-length
     name: ${{ matrix.task }} ${{ matrix.cuda_version }} ${{ matrix.method }} (${{ matrix.linux_version }}, ${{ matrix.compiler }}, Python ${{ matrix.python_version }})
     runs-on: [self-hosted, linux]
     needs: [restart-docker]
@@ -130,7 +134,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [test]
     steps:
-    - name: Note that all tests succeeded
-      uses: re-actors/[email protected]
-      with:
-        jobs: ${{ toJSON(needs) }}
+      - name: Note that all tests succeeded
+        uses: re-actors/[email protected]
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/lock.yml

@@ -32,12 +32,18 @@ jobs:
           remove-pr-labels: 'awaiting response,awaiting review,blocking,in progress'
           # what message should be posted prior to locking?
           issue-comment: >
-            This issue has been automatically locked since there has not been any recent activity since it was closed.
-            To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues
+            This issue has been automatically locked
+            since there has not been any recent activity since it was closed.
+
+            To start a new related discussion,
+            open a new issue at https://github.com/microsoft/LightGBM/issues
             including a reference to this.
           pr-comment: >
-            This pull request has been automatically locked since there has not been any recent activity since it was closed.
-            To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues
+            This pull request has been automatically locked
+            since there has not been any recent activity since it was closed.
+
+            To start a new related discussion,
+            open a new issue at https://github.com/microsoft/LightGBM/issues
             including a reference to this.
           # what should the locking status be?
           issue-lock-reason: 'resolved'

.github/workflows/no-response.yml

@@ -18,9 +18,14 @@ jobs:
       - uses: lee-dohm/[email protected]
         with:
           closeComment: >
-              This issue has been automatically closed because it has been awaiting a response for too long.
-              When you have time to to work with the maintainers to resolve this issue, please post a new comment and it will be re-opened.
-              If the issue has been locked for editing by the time you return to it, please open a new issue and reference this one.
+              This issue has been automatically closed
+              because it has been awaiting a response for too long.
+
+              When you have time to to work with the maintainers to resolve this issue,
+              please post a new comment and it will be re-opened.
+              If the issue has been locked for editing by the time you return to it,
+              please open a new issue and reference this one.
+
               Thank you for taking the time to improve LightGBM!
           daysUntilClose: 30
           responseRequiredLabel: awaiting response

.github/workflows/optional_checks.yml

@@ -22,8 +22,9 @@ jobs:
             )
             for i in "${workflows[@]}"; do
                 workflow_name=${i%;*}
+                comment="The last reported status from workflow \"$workflow_name\" is failure."
+                comment+=" Commit fixes and rerun the workflow."
                 trigger_phrase=${i#*;}
                 python "$GITHUB_WORKSPACE/.ci/get-workflow-status.py" "$trigger_phrase" \
-                || { echo "The last reported status from workflow \"$workflow_name\" is failure. Commit fixes and rerun the workflow."; \
-                exit 1; }
+                || { echo ${comment}; exit 1; }
             done

.github/workflows/python_package.yml

@@ -3,10 +3,10 @@ name: Python-package
 on:
   push:
     branches:
-    - master
+      - master
   pull_request:
     branches:
-    - master
+      - master
 
 # automatically cancel in-progress builds if another commit is pushed
 concurrency:
@@ -147,7 +147,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [test, test-latest-versions, test-oldest-versions]
     steps:
-    - name: Note that all tests succeeded
-      uses: re-actors/[email protected]
-      with:
-        jobs: ${{ toJSON(needs) }}
+      - name: Note that all tests succeeded
+        uses: re-actors/[email protected]
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/r_package.yml

@@ -3,10 +3,10 @@ name: R-package
 on:
   push:
     branches:
-    - master
+      - master
   pull_request:
     branches:
-    - master
+      - master
 
 # automatically cancel in-progress builds if another commit is pushed
 concurrency:
@@ -33,6 +33,7 @@ env:
 
 jobs:
   test:
+    # yamllint disable-line rule:line-length
     name: ${{ matrix.task }} (${{ matrix.os }}, ${{ matrix.compiler }}, R ${{ matrix.r_version }}, ${{ matrix.build_type }})
     runs-on: ${{ matrix.os }}
     container: ${{ matrix.container }}
@@ -230,7 +231,10 @@ jobs:
       - name: Install packages
         shell: bash
         run: |
-          RDscript${{ matrix.r_customization }} -e "install.packages(c('R6', 'data.table', 'jsonlite', 'knitr', 'markdown', 'Matrix', 'RhpcBLASctl', 'testthat'), repos = 'https://cran.rstudio.com', Ncpus = parallel::detectCores())"
+          R_LIBS="c('R6', 'data.table', 'jsonlite', 'knitr', 'markdown', 'Matrix', 'RhpcBLASctl', 'testthat')"
+          CRAN_MIRROR="https://cran.rstudio.com"
+          RDscript${{ matrix.r_customization }} \
+            -e "install.packages(${R_LIBS}, repos = '${CRAN_MIRROR}', Ncpus = parallel::detectCores())"
           sh build-cran-package.sh --r-executable=RD${{ matrix.r_customization }}
           RD${{ matrix.r_customization }} CMD INSTALL lightgbm_*.tar.gz || exit 1
       - name: Run tests with sanitizers
@@ -295,7 +299,10 @@ jobs:
       - name: Install packages and run tests
         shell: bash
         run: |
-          Rscript -e "install.packages(c('R6', 'data.table', 'jsonlite', 'knitr', 'markdown', 'Matrix', 'RhpcBLASctl'), repos = 'https://cran.rstudio.com', Ncpus = parallel::detectCores())"
+          R_LIBS="c('R6', 'data.table', 'jsonlite', 'knitr', 'markdown', 'Matrix', 'RhpcBLASctl')"
+          CRAN_MIRROR="https://cran.rstudio.com"
+          Rscript \
+            -e "install.packages(${R_LIBS}, repos = '${CRAN_MIRROR}', Ncpus = parallel::detectCores())"
           sh build-cran-package.sh
 
           # 'rchk' isn't run through 'R CMD check', use the approach documented at
@@ -344,7 +351,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [test, test-r-sanitizers, test-r-extra-checks]
     steps:
-    - name: Note that all tests succeeded
-      uses: re-actors/[email protected]
-      with:
-        jobs: ${{ toJSON(needs) }}
+      - name: Note that all tests succeeded
+        uses: re-actors/[email protected]
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/r_valgrind.yml

@@ -33,17 +33,25 @@ jobs:
       - name: Send init status
         if: ${{ always() }}
         run: |
-          $GITHUB_WORKSPACE/.ci/set-commit-status.sh "${{ github.workflow }}" "pending" "${{ github.event.client_payload.pr_sha }}"
+          $GITHUB_WORKSPACE/.ci/set-commit-status.sh \
+            "${{ github.workflow }}" \
+            "pending" \
+            "${{ github.event.client_payload.pr_sha }}"
+          comment="Workflow **${{ github.workflow }}** has been triggered! 🚀\r\n"
+          comment+="${GITHUB_SERVER_URL}/microsoft/LightGBM/actions/runs/${GITHUB_RUN_ID}"
           $GITHUB_WORKSPACE/.ci/append-comment.sh \
             "${{ github.event.client_payload.comment_number }}" \
-            "Workflow **${{ github.workflow }}** has been triggered! 🚀\r\n${GITHUB_SERVER_URL}/microsoft/LightGBM/actions/runs/${GITHUB_RUN_ID}"
+            "${comment}"
       - name: Run tests with valgrind
         shell: bash
         run: ./.ci/test-r-package-valgrind.sh
       - name: Send final status
         if: ${{ always() }}
         run: |
-          $GITHUB_WORKSPACE/.ci/set-commit-status.sh "${{ github.workflow }}" "${{ job.status }}" "${{ github.event.client_payload.pr_sha }}"
+          $GITHUB_WORKSPACE/.ci/set-commit-status.sh \
+            "${{ github.workflow }}" \
+            "${{ job.status }}" \
+            "${{ github.event.client_payload.pr_sha }}"
           $GITHUB_WORKSPACE/.ci/append-comment.sh \
             "${{ github.event.client_payload.comment_number }}" \
             "Status: ${{ job.status }}."

.github/workflows/static_analysis.yml

@@ -5,10 +5,10 @@ name: Static Analysis
 on:
   push:
     branches:
-    - master
+      - master
   pull_request:
     branches:
-    - master
+      - master
 
 # automatically cancel in-progress builds if another commit is pushed
 concurrency:
@@ -64,7 +64,10 @@ jobs:
       - name: Install packages
         shell: bash
         run: |
-          Rscript -e "install.packages(c('R6', 'data.table', 'jsonlite', 'knitr', 'markdown', 'Matrix', 'RhpcBLASctl', 'roxygen2', 'testthat'), repos = 'https://cran.rstudio.com', Ncpus = parallel::detectCores())"
+          R_LIBS="c('R6', 'data.table', 'jsonlite', 'knitr', 'markdown'"
+          R_LIBS+=", 'Matrix', 'RhpcBLASctl', 'roxygen2', 'testthat')"
+          CRAN_MIRROR="https://cran.rstudio.com"
+          Rscript -e "install.packages(${R_LIBS}, repos = '${CRAN_MIRROR}', Ncpus = parallel::detectCores())"
           sh build-cran-package.sh || exit 1
           R CMD INSTALL --with-keep.source lightgbm_*.tar.gz || exit 1
       - name: Test documentation
@@ -88,7 +91,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [test, r-check-docs]
     steps:
-    - name: Note that all tests succeeded
-      uses: re-actors/[email protected]
-      with:
-        jobs: ${{ toJSON(needs) }}
+      - name: Note that all tests succeeded
+        uses: re-actors/[email protected]
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/triggering_comments.yml

@@ -6,29 +6,32 @@ on:
 
 jobs:
   triggering-tests:
-    if: github.event.issue.pull_request && contains('OWNER,MEMBER,COLLABORATOR', github.event.comment.author_association) && startsWith(github.event.comment.body, '/gha run')
+    if: |
+      github.event.issue.pull_request &&
+      contains('OWNER,MEMBER,COLLABORATOR', github.event.comment.author_association) &&
+      startsWith(github.event.comment.body, '/gha run')
     runs-on: ubuntu-latest
     env:
       SECRETS_WORKFLOW: ${{ secrets.WORKFLOW }}
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 5
-        submodules: false
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 5
+          submodules: false
 
-    - name: Trigger R valgrind tests
-      if: github.event.comment.body == '/gha run r-valgrind'
-      run: |
-        $GITHUB_WORKSPACE/.ci/trigger-dispatch-run.sh \
-          "${{ github.event.issue.pull_request.url }}" \
-          "${{ github.event.comment.id }}" \
-          "gha_run_r_valgrind"
+      - name: Trigger R valgrind tests
+        if: github.event.comment.body == '/gha run r-valgrind'
+        run: |
+          $GITHUB_WORKSPACE/.ci/trigger-dispatch-run.sh \
+            "${{ github.event.issue.pull_request.url }}" \
+            "${{ github.event.comment.id }}" \
+            "gha_run_r_valgrind"
 
-    - name: Trigger update R configure
-      if: github.event.comment.body == '/gha run r-configure'
-      run: |
-        $GITHUB_WORKSPACE/.ci/trigger-dispatch-run.sh \
-          "${{ github.event.issue.pull_request.url }}" \
-          "${{ github.event.comment.id }}" \
-          "gha_run_r_configure"
+      - name: Trigger update R configure
+        if: github.event.comment.body == '/gha run r-configure'
+        run: |
+          $GITHUB_WORKSPACE/.ci/trigger-dispatch-run.sh \
+            "${{ github.event.issue.pull_request.url }}" \
+            "${{ github.event.comment.id }}" \
+            "gha_run_r_configure"

.pre-commit-config.yaml

@@ -17,6 +17,11 @@ repos:
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: ["--strict"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
     rev: v0.8.3