Use `--unsafe` YAML check for `mkdocs.yml` #911

StevenMaude · 2022-08-10T13:55:51Z

The check currently fails because we use the !! syntax in the current
mkdocs.yml configuration.

--unsafe refers to the YAML compliance: it doesn't load the file, merely
checks the syntax:

Instead of loading the files, simply parse them for syntax.
A syntax-only check enables extensions and unsafe constructs which would otherwise be forbidden.
Using this option removes all guarantees of portability to other yaml implementations.

https://github.com/pre-commit/pre-commit-hooks/blob/98c88b23b7ea9a42f920adc1d7c8790f39772021/README.md#check-yaml

This is still better than the current situation because:

a complete failure requires a committer to use --no-verify
or spend time trying to work out what's wrong with the pre-commit
failure
there is still a rudimentary check of this YAML, which doesn't happen
in the current broken state

In practice, this YAML file gets loaded by MkDocs, which tells us if it's broken
anyway.

Other YAML files in this repository are still checked fully.

See pre-commit/pre-commit-hooks#273 The check currently fails because we use the `!!` syntax in the current `mkdocs.yml` configuration. `--unsafe` refers to the YAML compliance: it doesn't load the file, merely checks the syntax: > Instead of loading the files, simply parse them for syntax. > A syntax-only check enables extensions and unsafe constructs which would otherwise be forbidden. > Using this option removes all guarantees of portability to other yaml implementations. https://github.com/pre-commit/pre-commit-hooks/blob/98c88b23b7ea9a42f920adc1d7c8790f39772021/README.md#check-yaml This is still better than the current situation because: * a complete failure requires a committer to use `--no-verify` or spend time trying to work out what's wrong with the pre-commit failure * there is still a rudimentary check of this YAML, which doesn't happen in the current broken state In practice, this YAML file gets loaded by MkDocs, which tells us if it's broken anyway. Other YAML files in this repository are still checked fully.