Jamie Tanna
8108714fc3
* docs: correct `onboardingConfig` example As we'll be enforcing this as valid Global config in future commits. Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io> * docs: correct `module.exports` syntax As we'll be enforcing this as valid Global config in future commits. Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io> * docs: completely skip `doc-fence-check` on code blocks only used for synatx highlighting Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io> * docs: skip schema validation on non-config snippets As we'll be enforcing this as valid Global config in future commits. Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io> * chore(tools/doc-fence-check): validate JSONC and Javascript code blocks To further ensure that our documentation is well-formed, we can validate that JSONC and Javascript code blocks are well-formed syntactically, and are valid Renovate configuration. Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io> * chore(tools/doc-fence-check): allow opting out of syntax validation On top of schema validation wanting to be disabled, we should also support disabling the syntax validation, in the case that we're using `json` code blocks for syntax highlighting, but they're not necessarily well-formed JSON. Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io> * docs: use `json` syntax highlighting As `jsonc` doesn't seem to exist in Material for MkDocs. As it's only for syntax highlighting, we need to opt out of validation. * tsc --------- Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io>
2.5 KiB
Docs site
The Renovate docs site is built from this repository.
The publishing process is triggered automatically on commits to main.
If you have submitted a documentation PR and your changes are not published within a day feel free to ping the maintainers, on the PR that introduced the docs change.
Fenced code blocks
json, jsonc, js and javascript code blocks will be validated to ensure that they are:
- well-formed JSON, JSONC, or JavaScript (
js/javascriptblocks are evaluated the same way Renovate loads a realconfig.jsfile) - Renovate config which does not need config migration
- valid Renovate configuration (with no warnings or errors)
js/javascript blocks default to being validated as Global Self-Hosted config, since repository config files cannot be JavaScript. json/jsonc blocks default to Repository config.
js/javascript validation only runs on files under docs/ and readme.md files under lib/, since other .md files in lib/ may contain arbitrary JavaScript examples unrelated to Renovate config.
This is validated through pnpm run doc-fence-check.
There are two comments you can add before a code block to opt out of validation, while still keeping the block's language tag for syntax highlighting:
<!-- schema-validation-disable-next-block -->skips the Renovate config/schema/migration checks, but the block must still be well-formed JSON, JSONC, or JavaScript. Use this when the block is valid but intentionally not Renovate config, for example a cache data structure or extracted dependency data.<!-- doc-fence-check-disable-next-block -->skips validation entirely, including the well-formedness check. Use this when the block isn't even parseable as a single JSON/JSONC/JavaScript document, for example illustrative pseudocode, truncated examples, or debug log output.
Where a JSON code block is not Renovate config, you can specify:
```json {configType=none}
{
"in": "valid"
}
```
By default, the validation treats a JSON code block as Repository Config. When writing a JSON snippet for Global Self-Hosted config, you will need to note that:
```json {configType=global}
{
"allowedEnv": ["foo"]
}
```
It may be the case that there is a configuration warning that appears which may be safe to ignore, which can be done so with:
```json {ignoreConfigWarnings=true}
{
"example-deprecated": true
}
```