Merge pull request #181 from sir-gon/feature/yamllint

Feature/yamllint

Author: sir-gon

.github/dependabot.yml

@@ -2,6 +2,7 @@
 # package ecosystems to update and where the package manifests are located.
 # Please see the documentation for all configuration options:
 # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+---
 
 version: 2
 updates:

.github/workflows/codeql.yml

@@ -9,17 +9,28 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
+---
+
 name: CodeQL
 
 permissions: read-all
 
-on:
+on: # yamllint disable-line rule:truthy
   push:
-    branches: [ main, develop, feature/* ]
+    branches: ["main", "develop", "feature/*"]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: ["main"]
   schedule:
+    #        ┌───────────── minute (0 - 59)
+    #        │  ┌───────────── hour (0 - 23)
+    #        │  │ ┌───────────── day of the month (1 - 31)
+    #        │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #        │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        *  * * * *
     - cron: 26 23 * * 3
 
 jobs:
@@ -34,55 +45,60 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ java ]
+        language: [java]
+        # yamllint disable rule:line-length
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Use only 'java' to analyze code written in Java, Kotlin or both
         # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
+        # yamllint enable rule:line-length
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    - name: Set up JDK 20
-      uses: actions/setup-java@v4
-      with:
-        java-version: '20'
-        distribution: temurin
+      - name: Set up JDK 20
+        uses: actions/setup-java@v4
+        with:
+          java-version: '20'
+          distribution: temurin
 
-    # 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 }}
+          # yamllint disable rule:line-length
 
-        # 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
+          # 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.
 
+          # 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
+          # yamllint enable rule:line-length
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    # - name: Autobuild
-    #  uses: github/codeql-action/autobuild@v2
+      # yamllint disable rule:line-length
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      # - name: Autobuild
+      #  uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ 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
+      # ℹ️ 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.
+      #   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.
+      # yamllint enable rule:line-length
 
-    - run: |
-         echo Run, Build Application using script
-         ./gradlew build
+      - run: |
+          echo Run, Build Application using script
+          ./gradlew build
 
-    # - run: |
-    #     echo Run, Build Application using script
-    #     ./location_of_script_within_repo/buildscript.sh
+      # - 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}}

.github/workflows/docker-image.yml

@@ -1,11 +1,12 @@
-name: Docker Image CI
+---
 
+name: Docker Image CI
 
-on:
+on: # yamllint disable-line rule:truthy
   push:
-    branches: [ main, develop, feature/* ]
+    branches: ["main", "develop", "feature/*"]
   pull_request:
-      branches: [ main ]
+    branches: ["main"]
 
 permissions: read-all
 
@@ -17,28 +18,35 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Build the Docker image
-      run: make compose/rebuild
-    - name: Run test in Docker image
-      run: make compose/run
-    - name: Tag Docker image
-      run: docker tag algorithm-exercises-java:latest algorithm-exercises-java:${{ github.sha }}
-
-    - name: Run Snyk to check Docker image for vulnerabilities
-      # Snyk can be used to break the build when it detects vulnerabilities.
-      # In this case we want to upload the issues to GitHub Code Scanning
-      continue-on-error: true
-      uses: snyk/actions/docker@master
-      env:
-        # In order to use the Snyk Action you will need to have a Snyk API token.
-        # See https://docs.snyk.io/integrations/ci-cd-integrations/github-actions-integration#getting-your-snyk-token
-        # or you can sign up for free at https://snyk.io/login
-        SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-      with:
-        image: algorithm-exercises-java:latest
-        args: --file=Dockerfile
-    # - name: Upload result to GitHub Code Scanning
-    #   uses: github/codeql-action/upload-sarif@v2
-    #   with:
-    #     sarif_file: snyk.sarif
+      - uses: actions/checkout@v4
+      - name: Build the Docker image
+        run: make compose/rebuild
+      - name: Run test in Docker image
+        run: make compose/run
+      - name: Tag Docker image
+        run: >
+          docker tag
+          algorithm-exercises-java:latest
+          algorithm-exercises-java:${{ github.sha }}
+
+      - name: Run Snyk to check Docker image for vulnerabilities
+        # Snyk can be used to break the build when it detects vulnerabilities.
+        # In this case we want to upload the issues to GitHub Code Scanning
+        continue-on-error: true
+        uses: snyk/actions/docker@master
+        env:
+          # yamllint disable rule:line-length
+          # In order to use the Snyk Action you will need to have a Snyk API token.
+          # See https://docs.snyk.io/integrations/ci-cd-integrations/github-actions-integration#getting-your-snyk-token
+          # or you can sign up for free at https://snyk.io/login
+          # yamllint enable rule:line-length
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+        with:
+          image: algorithm-exercises-java:latest
+          args: --file=Dockerfile
+      # yamllint disable rule:comments-indentation
+      # - name: Upload result to GitHub Code Scanning
+      #   uses: github/codeql-action/upload-sarif@v2
+      #   with:
+      #     sarif_file: snyk.sarif
+      # yamllint enable rule:comments-indentation

.github/workflows/gitleaks.yml

@@ -1,5 +1,8 @@
+---
+
 name: gitleaks
-on:
+
+on: # yamllint disable-line rule:truthy
   pull_request:
   push:
   workflow_dispatch:
@@ -16,4 +19,5 @@ jobs:
       - uses: gitleaks/gitleaks-action@v2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE}} # Only required for Organizations, not personal accounts.
+          # Only required for Organizations, not personal accounts.
+          # GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE}}

.github/workflows/java-gradle-coverage.yml

@@ -1,37 +1,36 @@
+# yamllint disable rule:line-length
 # This workflow uses actions that are not certified by GitHub.
 # They are provided by a third-party and are governed by
 # separate terms of service, privacy policy, and support
 # documentation.
 # This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
+# yamllint enable rule:line-length
+---
 
 name: Java CI Coverage with Gradle
 
-on:
+on: # yamllint disable-line rule:truthy
   push:
-    branches: [ main, develop, feature/* ]
+    branches: ["main", "develop", "feature/*"]
   pull_request:
-    branches: [ main ]
+    branches: ["main"]
 
 permissions:
   contents: read
 
 jobs:
-  gradle:
-
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-    runs-on: ${{ matrix.os }}
+  coverage:
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
       - name: Set up JDK
         uses: actions/setup-java@v4
         with:
-          java-version: '21'
+          java-version: 21
+          # Alternative distribution options are available
           distribution: temurin
-
       - name: Validate Gradle wrapper
         uses: gradle/actions/wrapper-validation@v3
 

.github/workflows/java-gradle.yml

@@ -1,28 +1,30 @@
+# yamllint disable rule:line-length
 # This workflow uses actions that are not certified by GitHub.
 # They are provided by a third-party and are governed by
 # separate terms of service, privacy policy, and support
 # documentation.
 # This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
+# yamllint enable rule:line-length
+---
 
 name: Java CI Tests with Gradle
 
-on:
+on: # yamllint disable-line rule:truthy
   push:
-    branches: [ main, develop, feature/* ]
+    branches: ["main", "develop", "feature/*"]
   pull_request:
-    branches: [ main ]
+    branches: ["main"]
 
 permissions:
   contents: read
 
 jobs:
   gradle:
-
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        java: [ '20', '21' ]
+        java: ['20', '21']
     runs-on: ${{ matrix.os }}
 
     steps:

.github/workflows/markdown-lint.yml

@@ -1,36 +1,37 @@
+---
 name: Markdown Lint
 
-on:
+on: # yamllint disable-line rule:truthy
   push:
-    branches: [ main, develop, feature/* ]
+    branches: ["main", "develop", "feature/*"]
   pull_request:
-    branches: [ main ]
+    branches: ["main"]
 
 permissions: read-all
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        os: [ubuntu-latest]
         node-version: [20.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        # See supported Node.js release schedule
+        # at https://nodejs.org/en/about/releases/
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-
-    - name: Set up Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    - name: Install dependencies
-      run: npm install -g markdownlint-cli
+      - name: Set up Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
 
-    - name: Lint
-      run: markdownlint '**/*.md' --ignore node_modules && echo '✔  Your code looks good.'
+      - name: Install dependencies
+        run: npm install -g markdownlint-cli
 
+      - name: Lint
+        run: >
+          markdownlint '**/*.md' --ignore node_modules
+          && echo '✔  Your code looks good.'