Added yamllint pre-commit hook

Author: ddabble

.codeclimate.yml

@@ -1,6 +1,7 @@
+---
 version: "2"         # Required to adjust maintainability checks
 
-checks: # https://docs.codeclimate.com/docs/maintainability#section-checks
+checks:  # https://docs.codeclimate.com/docs/maintainability#section-checks
   argument-count:
     config:
       threshold: 7
@@ -10,7 +11,7 @@ checks: # https://docs.codeclimate.com/docs/maintainability#section-checks
   file-lines:
     config:
       threshold: 500
-  method-complexity: # https://docs.codeclimate.com/docs/cognitive-complexity
+  method-complexity:  # https://docs.codeclimate.com/docs/cognitive-complexity
     config:
       threshold: 5
   method-count:
@@ -25,7 +26,7 @@ checks: # https://docs.codeclimate.com/docs/maintainability#section-checks
   return-statements:
     config:
       threshold: 4
-  similar-code: # https://docs.codeclimate.com/docs/duplication-concept
+  similar-code:  # https://docs.codeclimate.com/docs/duplication-concept
     config:
       threshold:  # Language-specific defaults; an override will affect all languages
   identical-code:
@@ -43,7 +44,7 @@ plugins:
   pep8:
     enabled: true
     checks:
-      E501: # Line too long (> 79 characters)
+      E501:  # Line too long (> 79 characters)
         enabled: false
   # https://docs.codeclimate.com/docs/radon
   radon:

.github/actions/install-dependencies/action.yml

@@ -19,7 +19,8 @@ runs:
 
     - name: Install System Dependencies
       shell: bash
-      # Retries installing files 3 times, as either the GitHub Actions runner or APT's API can be unreliable
+      # Retries installing files 3 times, as either the GitHub Actions runner or APT's
+      # API can be unreliable
       run: |
         sudo apt update
         sudo apt install python3-dev libldap2-dev libsasl2-dev libssl-dev -o Acquire::Retries=3

.github/dependabot.yml

@@ -1,3 +1,4 @@
+---
 version: 2
 updates:
   - package-ecosystem: "uv"

.github/workflows/_reusable_add-content-to-project.yml

@@ -1,48 +1,61 @@
-# This is a reusable workflow; see https://docs.github.com/en/actions/using-workflows/reusing-workflows.
-# It was created because GitHub projects' workflows (see e.g. https://github.com/orgs/MAKENTNU/projects/1/workflows)
-# don't (currently) support doing the specific things done in the steps below.
+---
+# This is a reusable workflow - see
+# https://docs.github.com/en/actions/using-workflows/reusing-workflows.
+# It was created because GitHub projects' workflows (see e.g.
+# https://github.com/orgs/MAKENTNU/projects/1/workflows) don't (currently) support doing
+# the specific things done in the steps below.
 #
 # The workflow requires that the following repository variables have been created:
-# - `ORGANIZATION_PROJECT_NUMBER` - The number/ID in the project URL (https://github.com/orgs/MAKENTNU/projects/1)
+# - `ORGANIZATION_PROJECT_NUMBER` - The number/ID in the project URL
+#   (https://github.com/orgs/MAKENTNU/projects/1)
 # - `ORGANIZATION_PROJECT__DATE_FIELD_NAME` - The name of the project's date field
-# - `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_CLOSED_ITEMS` - The value of the 'Status' field set for an item when closed
-#                                                           (see https://github.com/orgs/MAKENTNU/projects/1/workflows/3569450)
-# and the following organization variables:
-# - `ORGANIZATION_NAME` - The name of the organization in the project URL (https://github.com/orgs/MAKENTNU/projects/1)
+# - `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_CLOSED_ITEMS` - The value of the 'Status'
+#   field set for an item when closed (see
+#   https://github.com/orgs/MAKENTNU/projects/1/workflows/3569450)
+# ...and the following organization variables:
+# - `ORGANIZATION_NAME` - The name of the organization in the project URL
+#   (https://github.com/orgs/MAKENTNU/projects/1)
 #
-# The workflow also expects that the following project workflows are turned on for the project:
+# The workflow also expects that the following project workflows are turned on for
+# the project:
 # - "Item closed" (https://github.com/orgs/MAKENTNU/projects/1/workflows/3569450):
 #   - "When an item is closed": "issue, pull request"
-#   - "Set value": "Status: <the value of the `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_CLOSED_ITEMS` repository variable>"
-# and that the following project workflows are turned off:
+#   - "Set value": "Status: <the value of
+#     the `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_CLOSED_ITEMS` repository variable>"
+# ...and that the following project workflows are turned off:
 # - "Item added to project"
 # - "Item reopened"
-# (The "Pull request merged" project workflow (https://github.com/orgs/MAKENTNU/projects/1/workflows/3569451)
-# does not affect and is not affected by any of this.
-# However, it could be natural that it sets the same value as the "Item closed" project workflow.)
+# (The "Pull request merged" project workflow
+# (https://github.com/orgs/MAKENTNU/projects/1/workflows/3569451) does not affect and is
+# not affected by any of this. However, it could be natural that it sets the same value
+# as the "Item closed" project workflow.)
 
 name: Add content to project
 
 on:
   workflow_call:
     inputs:
       content_id:
-        description: "The ID of an issue or a PR, to be added to this repo's GitHub project"
+        description: >
+          The ID of an issue or a PR, to be added to this repo's GitHub project
         required: true
         type: string
       status_field_value_name:
-        description: "The name of one of the values of the project's (single select) 'Status' field, to set for the added project item"
+        description: >
+          The name of one of the values of the project's (single select) 'Status' field,
+          to set for the added project item
         required: true
         type: string
 
 jobs:
   add_content:
     runs-on: ubuntu-latest
-    # Code based on https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions#example-workflow-authenticating-with-a-github-app
+    # Code based on
+    # https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions#example-workflow-authenticating-with-a-github-app
     steps:
       - name: Generate token
         id: generate_token
-        uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # v2.1.0
+        uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a  # v2.1.0
         with:
           app_id: ${{ secrets.MAKE_BOT_APP_ID }}
           private_key: ${{ secrets.MAKE_BOT_APP_PEM }}
@@ -89,7 +102,8 @@ jobs:
             echo "DATE_FIELD_ID=$(jq --arg FIELD_NAME "$DATE_FIELD_NAME" -r '.data.organization.projectV2.fields.nodes[] | select(.name==$FIELD_NAME) | .id' project_data.json)"
             # The ID of the project's status field
             echo "STATUS_FIELD_ID=$(jq --arg FIELD_NAME "$STATUS_FIELD_NAME" -r '.data.organization.projectV2.fields.nodes[] | select(.name==$FIELD_NAME) | .id' project_data.json)"
-            # The ID of one of the values of the project's (single select) status field, with name `inputs.status_field_value_name`
+            # The ID of one of the values of the project's (single select) status field,
+            # with name `inputs.status_field_value_name`
             echo "STATUS_FIELD_VALUE_ID=$(jq --arg FIELD_NAME "$STATUS_FIELD_NAME" --arg STATUS_NAME "$STATUS_FIELD_VALUE_NAME" -r '.data.organization.projectV2.fields.nodes[] | select(.name==$FIELD_NAME) | .options[] | select(.name==$STATUS_NAME) | .id' project_data.json)"
           } >> "$GITHUB_ENV"
 
@@ -107,7 +121,8 @@ jobs:
               }
             }' -f project="$PROJECT_ID" -f content="$CONTENT_ID" --jq '.data.addProjectV2ItemById.item.id' )"
 
-          # The ID of the project item (representing an issue or a PR with ID `inputs.content_id`), which was either added or already existed
+          # The ID of the project item (representing an issue or a PR with ID
+          # `inputs.content_id`), which was either added or already existed
           echo "ITEM_ID=$item_id" >> "$GITHUB_ENV"
 
       - name: Get project item data
@@ -145,16 +160,19 @@ jobs:
           {
             # The value of the project item's date field (with ID `env.DATE_FIELD_ID`)
             echo "DATE_FIELD_VALUE=$(jq --arg FIELD_ID "$DATE_FIELD_ID" -r '.data.node.fieldValues.nodes[] | select(.field.id==$FIELD_ID) | .date' project_item_data.json)"
-            # The value of the project item's status field (with ID `env.STATUS_FIELD_ID`)
+            # The value of the project item's status field (with ID
+            # `env.STATUS_FIELD_ID`)
             echo "STATUS_FIELD_VALUE=$(jq --arg FIELD_ID "$STATUS_FIELD_ID" -r '.data.node.fieldValues.nodes[] | select(.field.id==$FIELD_ID) | .name' project_item_data.json)"
           } >> "$GITHUB_ENV"
 
       - name: Set status
         # Only set the status if it's not already set,
-        # or if it's a reopened issue/PR (as they should be marked with the value of `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_CLOSED_ITEMS` when closed
-        # - see https://github.com/orgs/MAKENTNU/projects/1/workflows/3569450)
+        # or if it's a reopened issue/PR (as they should be marked with the value of
+        # `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_CLOSED_ITEMS` when closed - see
+        # https://github.com/orgs/MAKENTNU/projects/1/workflows/3569450)
         if: ${{ !env.STATUS_FIELD_VALUE
-          || github.event.action == 'reopened' && env.STATUS_FIELD_VALUE == vars.ORGANIZATION_PROJECT__STATUS_VALUE_FOR_CLOSED_ITEMS }}
+          || github.event.action == 'reopened'
+          && env.STATUS_FIELD_VALUE == vars.ORGANIZATION_PROJECT__STATUS_VALUE_FOR_CLOSED_ITEMS }}
         env:
           GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
         run: |

.github/workflows/ci.yml

@@ -1,6 +1,7 @@
+---
 name: CI
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 jobs:
   lint:

.github/workflows/codeql-analysis.yml

@@ -1,11 +1,12 @@
+---
 name: "CodeQL"
 
 on:
   push:
-    branches: [ 'main' ]
+    branches: ['main']
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ 'main' ]
+    branches: ['main']
   schedule:
     # Runs at 06:45 UTC every Monday
     - cron: '45 6 * * 1'
@@ -26,7 +27,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'python', 'javascript' ]
+        language: ['python', 'javascript']
         # 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
@@ -37,7 +38,8 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Install System Dependencies
-        # Retries installing files 3 times, as the GitHub Actions CI is occasionally unreliable
+        # Retries installing files 3 times, as either the GitHub Actions runner or APT's
+        # API can be unreliable
         run: |
           sudo apt update
           sudo apt install python3-dev libldap2-dev libsasl2-dev libssl-dev -o Acquire::Retries=3

.github/workflows/project-add-issue.yml

@@ -1,12 +1,14 @@
+---
 # This workflow requires that the following repository variables have been created:
-# - `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_ADDED_ISSUES` - The value of the 'Status' field to set for issues when added to the project.
-# in addition to the ones required by `_reusable_add-content-to-project.yml`.
+# - `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_ADDED_ISSUES` - The value of the 'Status'
+#   field to set for issues when added to the project.
+# ...in addition to the ones required by `_reusable_add-content-to-project.yml`.
 
 name: Add issues to project
 
 on:
   issues:
-    types: [ opened, reopened ]
+    types: [opened, reopened]
 
 jobs:
   add_to_project:

.github/workflows/project-add-pull-request.yml

@@ -1,12 +1,14 @@
+---
 # This workflow requires that the following repository variables have been created:
-# - `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_ADDED_PULL_REQUESTS` - The value of the 'Status' field to set for pull requests when added to the project.
-# in addition to the ones required by `_reusable_add-content-to-project.yml`.
+# - `ORGANIZATION_PROJECT__STATUS_VALUE_FOR_ADDED_PULL_REQUESTS` - The value of
+#   the 'Status' field to set for pull requests when added to the project.
+# ...in addition to the ones required by `_reusable_add-content-to-project.yml`.
 
 name: Add pull requests to project
 
 on:
   pull_request:
-    types: [ opened, reopened, ready_for_review ]
+    types: [opened, reopened, ready_for_review]
 
 jobs:
   add_to_project:

.pre-commit-config.yaml

@@ -19,6 +19,20 @@ repos:
     hooks:
       - id: validate-pyproject
 
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.37.1
+    hooks:
+      - id: yamllint
+        args:
+          - '--config-data={
+              extends: default,
+              rules: {
+                line-length: {max: 88, level: warning},
+                new-lines: {type: platform},
+                truthy: disable,
+              },
+            }'
+
   - repo: meta
     hooks:
       - id: check-hooks-apply

CHANGELOG.md

@@ -45,6 +45,7 @@ Lastly, a new [release](https://github.com/MAKENTNU/web/releases) must be create
   - ...with the following hooks:
     - Several of the standard `pre-commit-hooks` and `meta` hooks
     - `validate-pyproject`
+    - `yamllint`
 
 
 ## 2025-05-03 (MAKENTNU/web#757)