style(yamllint): fix yaml linting issues

Liber-UFPE · Feb 14, 2024 · 5d0d3f0 · 5d0d3f0
1 parent f35fef4
commit 5d0d3f0
Show file tree

Hide file tree

Showing 13 changed files with 107 additions and 49 deletions.
diff --git a/.github/gradle-action/action.yml b/.github/gradle-action/action.yml
@@ -1,3 +1,4 @@
+---
 name: 'Gradle Build Action'
 description: 'Reusable GitHub Action for performing a gradle build or running a gradle task.'
 

diff --git a/.github/mergify.yml b/.github/mergify.yml
@@ -1,3 +1,4 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 queue_rules:

diff --git a/.github/sync.yml b/.github/sync.yml
@@ -1,7 +1,8 @@
+---
 group:
   # Using Bootstrap 5
   - files:
-      - # dotfiles to sync
+      # dotfiles to sync
       - .dockerignore
       - .editorconfig
       - .envrc

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,15 +1,22 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 name: CI
 
+# yamllint disable rule:truthy
 on:
   push:
     branches: [ "main" ]
   pull_request:
     types: [ "opened", "synchronize", "reopened" ]
+# yamllint enable rule:truthy
 
 env:
-  GRADLE_OPTS: '-Dorg.gradle.console=plain -Dorg.gradle.caching=true -Dsonar.gradle.skipCompile=true -Dorg.gradle.jvmargs="-Xmx2g -XX:MaxMetaspaceSize=512m"'
+  GRADLE_OPTS: >
+    -Dorg.gradle.console=plain
+    -Dorg.gradle.caching=true
+    -Dsonar.gradle.skipCompile=true
+    -Dorg.gradle.jvmargs="-Xmx2g -XX:MaxMetaspaceSize=512m"'
 
 concurrency:
   # This workflow cuts releases, so we want only a
@@ -56,7 +63,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "lts/*" # latest lts
+          node-version: "lts/*"  # latest lts
           check-latest: true
           cache: "npm"
       - name: npm install
@@ -71,7 +78,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "lts/*" # latest lts
+          node-version: "lts/*"  # latest lts
           check-latest: true
           cache: "npm"
       - name: npm install
@@ -226,7 +233,7 @@ jobs:
     # https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
     permissions:
       contents: write
-      packages: read # to preserve default permissions
+      packages: read  # to preserve default permissions
     env:
       GH_TOKEN: ${{ github.token }}
       TAG_NAME: ${{ needs.generate-tag-name.outputs.tagName }}
@@ -254,13 +261,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0 # 0 indicates all history for all branches and tags.
+          fetch-depth: 0  # 0 indicates all history for all branches and tags.
       - uses: docker/setup-qemu-action@v3
       - uses: docker/setup-buildx-action@v3
       - name: Docker / Get image name
         id: dockerImageName
+        # yamllint disable rule:line-length
+        # language="shell script"
         run: |
           echo "dockerImageName=${{ env.REGISTRY }}/${{ github.repository }}" | tr '[:upper:]' '[:lower:]'>> "$GITHUB_OUTPUT"
+        # yamllint enable rule:line-length
       - name: Create Image
         run: docker image build -t ${{ steps.dockerImageName.outputs.dockerImageName }}:latest .
       # Needs to log in to use docker scout below

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -1,17 +1,24 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 name: "CodeQL"
 
+# yamllint disable rule:truthy
 on:
   push:
     branches: [ "main" ]
   pull_request:
     types: [ "opened", "synchronize", "reopened" ]
   schedule:
     - cron: "32 11 * * 5"
+# yamllint enable rule:truthy
 
 env:
-  GRADLE_OPTS: '-Dorg.gradle.console=plain -Dorg.gradle.caching=true -Dsonar.gradle.skipCompile=true -Dorg.gradle.jvmargs="-Xmx2g -XX:MaxMetaspaceSize=512m"'
+  GRADLE_OPTS: >
+    -Dorg.gradle.console=plain
+    -Dorg.gradle.caching=true
+    -Dsonar.gradle.skipCompile=true
+    -Dorg.gradle.jvmargs="-Xmx2g -XX:MaxMetaspaceSize=512m"'
 
 jobs:
   analyze:
@@ -38,42 +45,32 @@ jobs:
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    # Setup project required versions of Gradle and Java
-    - name: Set up Gradle and Java
-      uses: ./.github/gradle-action
+      # Setup project required versions of Gradle and Java
+      - name: Set up Gradle and Java
+        uses: ./.github/gradle-action
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v3
 
-        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+      # - run: |
+      #     echo "Run, Build Application using script"
+      #     ./location_of_script_within_repo/buildscript.sh
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-    #   If the Autobuild fails above, remove it and uncomment the following three lines.
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-    # - run: |
-    #     echo "Run, Build Application using script"
-    #     ./location_of_script_within_repo/buildscript.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
-      with:
-        category: "/language:${{matrix.language}}"
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -1,8 +1,11 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 name: 'Dependency Review'
 
+# yamllint disable rule:truthy
 on: [pull_request]
+# yamllint enable rule:truthy
 
 permissions:
   contents: read
@@ -16,4 +19,4 @@ jobs:
         uses: actions/dependency-review-action@v4
         with:
           fail-on-severity: high
-          fail-on-scopes: runtime
+          fail-on-scopes: runtime
diff --git a/.github/workflows/lighthouse.yml b/.github/workflows/lighthouse.yml
@@ -1,15 +1,22 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 name: Lighthouse CI
 
+# yamllint disable rule:truthy
 on:
   push:
     branches: [ "main" ]
   pull_request:
     types: [ "opened", "synchronize", "reopened" ]
+# yamllint enable rule:truthy
 
 env:
-  GRADLE_OPTS: '-Dorg.gradle.console=plain -Dorg.gradle.caching=true -Dsonar.gradle.skipCompile=true -Dorg.gradle.jvmargs="-Xmx2g -XX:MaxMetaspaceSize=512m"'
+  GRADLE_OPTS: >
+    -Dorg.gradle.console=plain
+    -Dorg.gradle.caching=true
+    -Dsonar.gradle.skipCompile=true
+    -Dorg.gradle.jvmargs="-Xmx2g -XX:MaxMetaspaceSize=512m"'
 
 jobs:
   lighthouse-ci:
@@ -28,4 +35,4 @@ jobs:
           PROJECT_TOKEN: ${{ vars.LHCI_PROJECT_TOKEN }}
           GITHUB_TOKEN: ${{ secrets.LHCI_GITHUB_TOKEN }}
           BASIC_AUTH_USERNAME: ${{ secrets.LHCI_BASIC_AUTH_USERNAME }}
-          BASIC_AUTH_PASSWORD: ${{ secrets.LHCI_BASIC_AUTH_PASSWORD }}
+          BASIC_AUTH_PASSWORD: ${{ secrets.LHCI_BASIC_AUTH_PASSWORD }}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,15 +1,22 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 name: Main
 
+# yamllint disable rule:truthy
 on:
   push:
     branches: [ "main" ]
   release:
     types: [ "created", "published" ]
+# yamllint enable rule:truthy
 
 env:
-  GRADLE_OPTS: '-Dorg.gradle.console=plain -Dorg.gradle.caching=true -Dsonar.gradle.skipCompile=true -Dorg.gradle.jvmargs="-Xmx2g -XX:MaxMetaspaceSize=512m"'
+  GRADLE_OPTS: >
+    -Dorg.gradle.console=plain
+    -Dorg.gradle.caching=true
+    -Dsonar.gradle.skipCompile=true
+    -Dorg.gradle.jvmargs="-Xmx2g -XX:MaxMetaspaceSize=512m"'
 
 permissions:
   contents: write
@@ -26,4 +33,4 @@ jobs:
           java-version: "21"
           distribution: "temurin"
       - name: Generate and submit dependency graph
-        uses: gradle/actions/dependency-submission@v3
+        uses: gradle/actions/dependency-submission@v3
diff --git a/.github/workflows/repo-files-sync.yml b/.github/workflows/repo-files-sync.yml
@@ -1,10 +1,13 @@
+---
 name: Sync Files
 
+# yamllint disable rule:truthy
 on:
   workflow_run:
     types: [ completed ]
     workflows: [ CI ]
     branches: [ main ]
+# yamllint enable rule:truthy
 
 jobs:
   summary:
@@ -17,6 +20,7 @@ jobs:
           variables: >-
             COMMIT_SHA="${{ github.event.workflow_run.head_sha }}"
             SHORT_SHA="${COMMIT_SHA:0:7}"
+          # yamllint disable rule:line-length
           # language="markdown"
           template: |
             ## Workflow Run Summary
@@ -29,6 +33,7 @@ jobs:
             | Workflow Run Created At | ${{ github.event.workflow_run.created_at }}                                                 |
             | Workflow Run Updated At | ${{ github.event.workflow_run.updated_at }}                                                 |
             | Workflow Run Head SHA   | [`$SHORT_SHA`]($COMMIT_SHA)                                                                 |
+          # yamllint enable rule:line-length
 
   sync:
     runs-on: ubuntu-latest
@@ -37,7 +42,7 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
       - name: Run GitHub File Sync
-        uses: BetaHuhn/repo-file-sync-action@v1.21.0
+        uses: Liber-UFPE/repo-file-sync-action@v1.22.1
         with:
           GH_PAT: ${{ secrets.REPO_SYNC_PAT }}
-          COMMIT_EACH_FILE: false # Commit all files at once
+          COMMIT_EACH_FILE: false  # Commit all files at once
diff --git a/.github/workflows/validate-links.yml b/.github/workflows/validate-links.yml
@@ -1,12 +1,15 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 name: "Validate External Links"
 
+# yamllint disable rule:truthy
 on:
   push:
     branches: [ "main" ]
   pull_request:
     types: [ "opened", "synchronize", "reopened" ]
+# yamllint enable rule:truthy
 
 jobs:
   validate-external-links:

diff --git a/detekt-config.yml b/detekt-config.yml
@@ -1,8 +1,9 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 # This is supposed to be used together with `--build-upon-default-config` CLI option.
 # Meaning that all the defaults would be respected, except that we don't want to exclude
 # `DetektProgressListener`. Therefore, `exclude` is set to an empty array.
 processors:
   active: true
-  exclude: []
+  exclude: []
diff --git a/diktat-analysis.yml b/diktat-analysis.yml
@@ -1,3 +1,4 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 - name: DIKTAT_COMMON

diff --git a/micronaut-cli.yml b/micronaut-cli.yml
@@ -1,8 +1,29 @@
+---
 # DO NOT EDIT: this file is automatically synced from the template repository
 # in https://github.com/Liber-UFPE/project-starter.
 applicationType: default
 defaultPackage: br.ufpe.liber
 testFramework: kotest
 sourceLanguage: kotlin
 buildTool: gradle_kotlin
-features: [app-name, config4k, graalvm, gradle, http-client-test, kotest, kotlin, kotlin-application, kotlin-extension-functions, ksp, logback, micronaut-aot, micronaut-build, micronaut-http-validation, netty-server, properties, readme, serialization-jackson, shade, views-jte]
+features:
+  - app-name
+  - config4k
+  - graalvm
+  - gradle
+  - http-client-test
+  - kotest
+  - kotlin
+  - kotlin-application
+  - kotlin-extension-functions
+  - ksp
+  - logback
+  - micronaut-aot
+  - micronaut-build
+  - micronaut-http-validation
+  - netty-server
+  - properties
+  - readme
+  - serialization-jackson
+  - shade
+  - views-jte