[mod] lint github YAML config files

[return42]

What does this PR do?

yamllint github config files (YAML)

Why is this change important?

find issues before merge upstream into master branch

How to test this PR locally?

make test.yamllint

Related issues

• [mod] CI: tag commits with leading scope/type of the modification #3313

[dalf]

meh, I understand but the workflows are painful to test / develop. I often end up with git add .; git commit --ammend; git push --force until it works.
If the process crash because there is missing space, it will additional stress for no additional gain.
YMMV.

[return42]

meh, I understand but the workflows are painful to test / develop. I often end up with git add .; git commit --ammend; git push --force until it works.

Yeah, but you are talking about challenges in the development cycles when setting up a workflow, this PR is made to reduce avoidable errors / improve quality of YAML files.

If the process crash because there is missing space, it will additional stress

This yamllint test can be run before you create the commit and is started by the CI when we send a PR.

for no additional gain. YMMV.

The intention (gain) is to lint yaml files before merge commits into master (YAML files will be linted in the CI of a PR).

By example:

In #3313 I merged three YAML issues into the master tree --> https://github.com/searxng/searxng/actions/runs/8214791833/workflow#L117

To fix I needed two commits a48da9b and 691390b .. with the addition from this PR, YAML issues in the config files will be reported in the CI tests of a PR .. I would never had merged this yaml errors.

[dalf]

To fix I needed two commits a48da9b and 691390b .. with the addition from this PR, YAML issues in the config files will be reported in the CI tests of a PR .. I would never had merged this yaml errors.

I see these type of errors in my editor as I type.

This yamllint test can be run before you create the commit and is started by the CI when we send a PR.

It is going to do additional tests before the commit --> additional stress for nothing as long the editor make sure to show invalid YAML instantaneously.

[dalf]

About instant check, what is the purpose of these lines ?

searxng/.dir-locals.el

Lines 83 to 90 in 691390b

	;; flycheck should use the local py3 environment
	(setq-local flycheck-yaml-yamllint-executable
	(expand-file-name "bin/yamllint" python-shell-virtualenv-root))
	(setq-local flycheck-yamllintrc
	(expand-file-name ".yamllint.yml" prj-root))
	(flycheck-checker . yaml-yamllint)))))

Does it ask flycheck to run yaml-lint while you are editing?

[return42]

I see these type of errors in my editor as I type.

I see pyright and pylint issues in my editor but that is not a reason to remove these tests from the CI

additional stress for nothing as long the editor make sure to show invalid YAML instantaneously.

Sadly yaml-lint does not work yet well in my editor (emacs).

Does it ask flycheck to run yaml-lint while you are editing?

Yes, the intention is to set up the flycheck variables needed to start a yamllint in the emacs editor from the local python installation we have in local/py3/ (its like running the yammlint within a local/py3/bin/activate environment).

Sadly this setup does not work yet in my emacs .. 🤷

It is going to do additional tests before the commit --> additional stress

I don't have much experience with developing workflows, this PR would have helped me.

But if you think it unnecessarily complicates the development processes, then we can close the PR ... I will follow your lead, you have more experience than I do ..