feat: use yamllint to check YAML files, instead of simply parsing and pretty-printing them

Author: jenstroeger

.github/codeql/codeql-config.yaml

@@ -1,3 +1,5 @@
+# yamllint disable rule:document-start rule:document-end
+
 name: CodeQL configuration
 paths:
 - src/package

.github/dependabot.yaml

@@ -1,6 +1,8 @@
 # This configuration file enables Dependabot version updates.
 # https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates
 # https://github.com/dependabot/feedback/issues/551
+#
+# yamllint disable rule:document-start rule:document-end
 
 version: 2
 updates:

.github/workflows/_build.yaml

@@ -18,9 +18,11 @@
 # https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions
 #
 # for the security recommendations.
+#
+# yamllint disable rule:document-start rule:document-end
 
 name: Build the package
-on:
+on: # yamllint disable-line rule:truthy
   workflow_call:
     inputs:
       disable_pip_audit:

.github/workflows/_generate-rebase.yaml

@@ -1,8 +1,10 @@
 # Automatically rebase one branch on top of another; usually staging on top
 # of main after a new package version was published.
+#
+# yamllint disable rule:document-start rule:document-end
 
 name: Rebase branch
-on:
+on: # yamllint disable-line rule:truthy
   workflow_call:
     inputs:
       to_head:

.github/workflows/_release-notifications.yaml

@@ -1,8 +1,10 @@
 # Send a Slack release notification. Instructions to set up Slack to receive
 # messages can be found here: https://github.com/slackapi/slack-github-action#setup-2
+#
+# yamllint disable rule:document-start rule:document-end
 
 name: Release Notifications
-on:
+on: # yamllint disable-line rule:truthy
   workflow_call:
     inputs:
       repo_name:

.github/workflows/_wiki-documentation.yaml

@@ -1,9 +1,11 @@
 # This reusable workflow publishes Markdown docs to Github Wiki. Some manual
 # setup is required before using it: enable Wiki in repository and create at
 # least one page.
+#
+# yamllint disable rule:document-start rule:document-end
 
 name: Publish Github Wiki documentation
-on:
+on: # yamllint disable-line rule:truthy
   workflow_call:
     inputs:
       release_tag:

.github/workflows/codeql-analysis.yaml

@@ -1,8 +1,10 @@
 # Run CodeQL over the package. For more configuration options see codeql/codeql-config.yaml
 # and: https://github.com/github/codeql-action
+#
+# yamllint disable rule:document-start rule:document-end
 
 name: CodeQL
-on:
+on: # yamllint disable-line rule:truthy
   push:
     branches:
     - main

.github/workflows/dependabot-automerge.yaml

@@ -1,8 +1,10 @@
 # Automatically merge Dependabot PRs upon approval by leaving
 # a comment on Dependabot's pull-request.
+#
+# yamllint disable rule:document-start rule:document-end
 
 name: Automerge Dependabot PR
-on:
+on: # yamllint disable-line rule:truthy
   pull_request_review:
     types: [submitted]
 

.github/workflows/pr-change-set.yaml

@@ -1,8 +1,10 @@
 # This workflow checks and tests the package code, and it builds all package
 # artifacts whenever there were changes to a pull request.
+#
+# yamllint disable rule:document-start rule:document-end
 
 name: Check change set
-on:
+on: # yamllint disable-line rule:truthy
   pull_request:
     branches:
     - '*'

.github/workflows/pr-conventional-commits.yaml

@@ -2,9 +2,11 @@
 # package (https://github.com/commitizen-tools/commitizen) and its `cz`
 # tool to check the title of the PR and all commit messages of the branch
 # which triggers this Action.
+#
+# yamllint disable rule:document-start rule:document-end
 
 name: Check conventional commits
-on:
+on: # yamllint disable-line rule:truthy
   pull_request:
     branches:
     - '*'