Add yamllint (#26965)

So that https://github.com/go-gitea/gitea/pull/26964 does not happen
again. Merge this after that PR. Config is based on
[node's](https://github.com/nodejs/node/blob/main/.yamllint.yaml).

---------

Co-authored-by: techknowlogick <techknowlogick@gitea.com>

.eslintrc.yaml

@@ -156,7 +156,7 @@ rules:
   import/no-restricted-paths: [0]
   import/no-self-import: [2]
   import/no-unassigned-import: [0]
-  import/no-unresolved: [2, {commonjs: true, ignore: [\?.+$, ^vitest/]}]
+  import/no-unresolved: [2, {commonjs: true, ignore: ["\\?.+$", ^vitest/]}]
   import/no-unused-modules: [2, {unusedExports: true}]
   import/no-useless-path-segments: [2, {commonjs: true}]
   import/no-webpack-loader-syntax: [2]

.github/ISSUE_TEMPLATE/bug-report.yaml

@@ -2,11 +2,11 @@ name: Bug Report
 description: Found something you weren't expecting? Report it here!
 labels: ["kind/bug"]
 body:
-- type: markdown
+  - type: markdown
     attributes:
       value: |
         NOTE: If your issue is a security concern, please send an email to security@gitea.io instead of opening a public issue.
-- type: markdown
+  - type: markdown
     attributes:
       value: |
         1. Please speak English, this is the language all maintainers can speak and write.
@@ -17,21 +17,21 @@ body:
         4. Make sure it's not mentioned in the FAQ (https://docs.gitea.com/help/faq)
         5. It's really important to provide pertinent details and logs (https://docs.gitea.com/help/support),
            incomplete details will be handled as an invalid report.
-- type: textarea
+  - type: textarea
     id: description
     attributes:
       label: Description
       description: |
         Please provide a description of your issue here, with a URL if you were able to reproduce the issue (see below)
         If you are using a proxy or a CDN (e.g. Cloudflare) in front of Gitea, please disable the proxy/CDN fully and access Gitea directly to confirm the issue still persists without those services.
-- type: input
+  - type: input
     id: gitea-ver
     attributes:
       label: Gitea Version
       description: Gitea version (or commit reference) of your instance
     validations:
       required: true
-- type: dropdown
+  - type: dropdown
     id: can-reproduce
     attributes:
       label: Can you reproduce the bug on the Gitea demo site?
@@ -43,33 +43,33 @@ body:
         - "No"
     validations:
       required: true
-- type: markdown
+  - type: markdown
     attributes:
       value: |
         It's really important to provide pertinent logs
         Please read https://docs.gitea.com/administration/logging-config#collecting-logs-for-help
         In addition, if your problem relates to git commands set `RUN_MODE=dev` at the top of app.ini
-- type: input
+  - type: input
     id: logs
     attributes:
       label: Log Gist
       description: Please provide a gist URL of your logs, with any sensitive information (e.g. API keys) removed/hidden
-- type: textarea
+  - type: textarea
     id: screenshots
     attributes:
       label: Screenshots
       description: If this issue involves the Web Interface, please provide one or more screenshots
-- type: input
+  - type: input
     id: git-ver
     attributes:
       label: Git Version
       description: The version of git running on the server
-- type: input
+  - type: input
     id: os-ver
     attributes:
       label: Operating System
       description: The operating system you are using to run Gitea
-- type: textarea
+  - type: textarea
     id: run-info
     attributes:
       label: How are you running Gitea?
@@ -79,7 +79,7 @@ body:
         If you are using a package or systemd tell us what distribution you are using
     validations:
       required: true
-- type: dropdown
+  - type: dropdown
     id: database
     attributes:
       label: Database

.github/ISSUE_TEMPLATE/feature-request.yaml

@@ -2,14 +2,14 @@ name: Feature Request
 description: Got an idea for a feature that Gitea doesn't have currently?  Submit your idea here!
 labels: ["kind/proposal"]
 body:
-- type: markdown
+  - type: markdown
     attributes:
       value: |
         1. Please speak English, this is the language all maintainers can speak and write.
         2. Please ask questions or configuration/deploy problems on our Discord
            server (https://discord.gg/gitea) or forum (https://discourse.gitea.io).
         3. Please take a moment to check that your feature hasn't already been suggested.
-- type: textarea
+  - type: textarea
     id: description
     attributes:
       label: Feature Description
@@ -17,7 +17,7 @@ body:
         I think it would be great if Gitea had...
     validations:
       required: true
-- type: textarea
+  - type: textarea
     id: screenshots
     attributes:
       label: Screenshots

.github/ISSUE_TEMPLATE/ui.bug-report.yaml

@@ -2,11 +2,11 @@ name: Web Interface Bug Report
 description: Something doesn't look quite as it should?  Report it here!
 labels: ["kind/bug", "kind/ui"]
 body:
-- type: markdown
+  - type: markdown
     attributes:
       value: |
         NOTE: If your issue is a security concern, please send an email to security@gitea.io instead of opening a public issue.
-- type: markdown
+  - type: markdown
     attributes:
       value: |
         1. Please speak English, this is the language all maintainers can speak and write.
@@ -19,28 +19,28 @@ body:
         6. In particular it's really important to provide pertinent logs. If you are certain that this is a javascript
            error, show us the javascript console. If the error appears to relate to Gitea the server you must also give us
            DEBUG level logs. (See https://docs.gitea.com/administration/logging-config#collecting-logs-for-help)
-- type: textarea
+  - type: textarea
     id: description
     attributes:
       label: Description
       description: |
         Please provide a description of your issue here, with a URL if you were able to reproduce the issue (see below)
         If using a proxy or a CDN (e.g. CloudFlare) in front of gitea, please disable the proxy/CDN fully and connect to gitea directly to confirm the issue still persists without those services.
-- type: textarea
+  - type: textarea
     id: screenshots
     attributes:
       label: Screenshots
       description: Please provide at least 1 screenshot showing the issue.
     validations:
       required: true
-- type: input
+  - type: input
     id: gitea-ver
     attributes:
       label: Gitea Version
       description: Gitea version (or commit reference) your instance is running
     validations:
       required: true
-- type: dropdown
+  - type: dropdown
     id: can-reproduce
     attributes:
       label: Can you reproduce the bug on the Gitea demo site?
@@ -52,12 +52,12 @@ body:
         - "No"
     validations:
       required: true
-- type: input
+  - type: input
     id: os-ver
     attributes:
       label: Operating System
       description: The operating system you are using to access Gitea
-- type: input
+  - type: input
     id: browser-ver
     attributes:
       label: Browser Version

.github/labeler.yml

@@ -22,3 +22,4 @@ kind/lint:
   - ".markdownlint.yaml"
   - ".spectral.yaml"
   - ".stylelintrc.yaml"
+  - ".yamllint.yaml"

.github/workflows/files-changed.yml

@@ -17,6 +17,8 @@ on:
         value: ${{ jobs.detect.outputs.docker }}
       swagger:
         value: ${{ jobs.detect.outputs.swagger }}
+      yaml:
+        value: ${{ jobs.detect.outputs.yaml }}
 
 jobs:
   detect:
@@ -30,6 +32,7 @@ jobs:
       templates: ${{ steps.changes.outputs.templates }}
       docker: ${{ steps.changes.outputs.docker }}
       swagger: ${{ steps.changes.outputs.swagger }}
+      yaml: ${{ steps.changes.outputs.yaml }}
     steps:
       - uses: actions/checkout@v3
       - uses: dorny/paths-filter@v2
@@ -82,3 +85,8 @@ jobs:
               - "package.json"
               - "package-lock.json"
               - ".spectral.yaml"
+
+            yaml:
+              - "**/*.yml"
+              - "**/*.yaml"
+              - ".yamllint.yaml"

.github/workflows/pull-compliance.yml

@@ -39,6 +39,19 @@ jobs:
       - run: make deps-py
       - run: make lint-templates
 
+  lint-yaml:
+    if: needs.files-changed.outputs.yaml == 'true'
+    needs: files-changed
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - run: pip install poetry
+      - run: make deps-py
+      - run: make lint-yaml
+
   lint-swagger:
     if: needs.files-changed.outputs.swagger == 'true'
     needs: files-changed

.github/workflows/pull-db-tests.yml

@@ -88,7 +88,7 @@ jobs:
       mysql:
         image: mysql:5.7
         env:
-          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+          MYSQL_ALLOW_EMPTY_PASSWORD: true
           MYSQL_DATABASE: test
         ports:
           - "3306:3306"
@@ -160,7 +160,7 @@ jobs:
       mysql:
         image: mysql:5.7
         env:
-          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+          MYSQL_ALLOW_EMPTY_PASSWORD: true
           MYSQL_DATABASE: test
         ports:
           - "3306:3306"
@@ -205,7 +205,7 @@ jobs:
       mysql8:
         image: mysql:8
         env:
-          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+          MYSQL_ALLOW_EMPTY_PASSWORD: true
           MYSQL_DATABASE: testgitea
         ports:
           - "3306:3306"

.yamllint.yaml

@@ -0,0 +1,48 @@
+extends: default
+
+rules:
+  braces:
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: 0
+    max-spaces-inside-empty: 0
+
+  brackets:
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: 0
+    max-spaces-inside-empty: 0
+
+  comments:
+    require-starting-space: true
+    ignore-shebangs: true
+    min-spaces-from-content: 1
+
+  comments-indentation:
+    level: error
+
+  document-start:
+    level: error
+    present: false
+    ignore: |
+      /.drone.yml
+
+  document-end:
+    present: false
+
+  empty-lines:
+    max: 1
+
+  indentation:
+    spaces: 2
+
+  line-length: disable
+
+  truthy:
+    allowed-values: ["true", "false", "on", "off"]
+
+ignore: |
+  .venv
+  node_modules
+  /models/fixtures
+  /models/migrations/fixtures

Makefile

@@ -218,6 +218,7 @@ help:
 	@echo " - lint-md                          lint markdown files"
 	@echo " - lint-swagger                     lint swagger files"
 	@echo " - lint-templates                   lint template files"
+	@echo " - lint-yaml                        lint yaml files"
 	@echo " - checks                           run various consistency checks"
 	@echo " - checks-frontend                  check frontend files"
 	@echo " - checks-backend                   check backend files"
@@ -427,6 +428,10 @@ lint-actions:
 lint-templates: .venv
 	@poetry run djlint $(shell find templates -type f -iname '*.tmpl')
 
+.PHONY: lint-yaml
+lint-yaml: .venv
+	@poetry run yamllint .
+
 .PHONY: watch
 watch:
 	@bash build/watch.sh

poetry.lock

@@ -1,4 +1,4 @@
-# This file is automatically @generated by Poetry 1.5.1 and should not be changed by hand.
+# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand.
 
 [[package]]
 name = "click"
@@ -325,7 +325,25 @@ notebook = ["ipywidgets (>=6)"]
 slack = ["slack-sdk"]
 telegram = ["requests"]
 
+[[package]]
+name = "yamllint"
+version = "1.32.0"
+description = "A linter for YAML files."
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "yamllint-1.32.0-py3-none-any.whl", hash = "sha256:d97a66e48da820829d96077d76b8dfbe6c6140f106e558dae87e81ac4e6b30b7"},
+    {file = "yamllint-1.32.0.tar.gz", hash = "sha256:d01dde008c65de5b235188ab3110bebc59d18e5c65fc8a58267cd211cd9df34a"},
+]
+
+[package.dependencies]
+pathspec = ">=0.5.3"
+pyyaml = "*"
+
+[package.extras]
+dev = ["doc8", "flake8", "flake8-import-order", "rstcheck[sphinx]", "sphinx"]
+
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.8"
-content-hash = "1b154f70c35b75d47c843959af9df0e7343f3bb579835825ca889ec9350afc41"
+content-hash = "4017ac7637dcc0703b37f8dc640d3e11e67e60c7b14660838135cff38ad91656"

pyproject.toml

@@ -9,6 +9,7 @@ python = "^3.8"
 
 [tool.poetry.group.dev.dependencies]
 djlint = "1.32.1"
+yamllint = "^1.32.0"
 
 [tool.djlint]
 profile="golang"