docs: Config overview improvement #28209
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
HonkingGoose
suggested changes
Apr 3, 2024
| - Default config (bot defaults) | ||
| - Global config (admin settings) | ||
| - Inherited config (org-level settings) | ||
| - Repository config (repo-specific customisation) |
There was a problem hiding this comment.
Suggested change
| - Repository config (repo-specific customisation) | |
| - Repository config (repo-specific customization) |
We use American English, so this is with a z. 🙂
| Global config can contain config which is "global only" as well as any configuration options which are valid in Inherited config or Repository config. | ||
|
|
||
| Global config must be supplied when you run renovate locally or "self-host" renovate. |
There was a problem hiding this comment.
Suggested change
| Global config must be supplied when you run renovate locally or "self-host" renovate. | |
| Global config must be supplied when you run Renovate locally or "self-host" Renovate. |
Capitalize proper nouns.
Maybe this sentence needs to be moved down a bit? We mention below how users of the Mend hosted app don't need to worry about global config. But this sentence almost sounds like all users must configure global config.
| @@ -47,20 +48,28 @@ By default Renovate allows the config file to be _missing_ and does not error if | |||
| But if you have configured `RENOVATE_CONFIG_FILE` and the path you specified is not found then Renovate will error and exit, because it assumes you have a configuration problem. | |||
| If the file is found but cannot be parsed then Renovate will also error and exit. | |||
|
|
|||
| Global config files can be `.js` or `.json` files. | |||
| Global config files can be `.js` or `.json` or `.yaml` files, and must accordingly be formatted using JavaScript, JSON or YAML syntax. | |||
There was a problem hiding this comment.
Suggested change
| Global config files can be `.js` or `.json` or `.yaml` files, and must accordingly be formatted using JavaScript, JSON or YAML syntax. | |
| Global config files can be `.js`, `.json` or `.yaml` files. | |
| You must use the correct syntax for the file format, so JavaScript, JSON or YAML. |
| But we recommend you still check the documentation for the field `env` for each option to make sure. | ||
| If the configuration option lacks a `env` field, the config option also lacks a Environment config variable name. | ||
| As some environment variable names differ from the usual pattern, we recommend you still check the `env` field of the documentation for each config option to make sure. | ||
| If the configuration option lacks the `env` field, that config option may lack the facility to be configured by a separate environment variable. |
There was a problem hiding this comment.
Suggested change
| If the configuration option lacks the `env` field, that config option may lack the facility to be configured by a separate environment variable. | |
| If the configuration option does not have the `env` field, that config option can not be configured by a separate environment variable. |
I think something like this is easier to understand?
| If the configuration option lacks the `env` field, that config option may lack the facility to be configured by a separate environment variable. | ||
|
|
||
| The values assigned to the environment variables may be strings, numbers, booleans, or stringified JSON. | ||
| If using stringified JSON then be careful to use appropriate escaping. |
There was a problem hiding this comment.
Suggested change
| If using stringified JSON then be careful to use appropriate escaping. | |
| When you use stringified JSON check if you're escaping it properly. |
| The values assigned to the environment variables may be strings, numbers, booleans, or stringified JSON. | ||
| If using stringified JSON then be careful to use appropriate escaping. | ||
| Key names should be quoted using double quotes, as these are strings in JSON. | ||
| If environment variables are being set from a shell console or shell script, it is generally simplest to wrap the entire stringified JSON in single quotes to prevent the shell interpreter from parsing (and removing) the escaping or punctuation. |
There was a problem hiding this comment.
Suggested change
| If environment variables are being set from a shell console or shell script, it is generally simplest to wrap the entire stringified JSON in single quotes to prevent the shell interpreter from parsing (and removing) the escaping or punctuation. | |
| If environment variables are being set from a shell console or shell script: wrap the entire stringified JSON in _single_ quotes. | |
| This prevents the shell interpreter from parsing (and removing) the escaping or punctuation. |
| If using stringified JSON then be careful to use appropriate escaping. | ||
| Key names should be quoted using double quotes, as these are strings in JSON. | ||
| If environment variables are being set from a shell console or shell script, it is generally simplest to wrap the entire stringified JSON in single quotes to prevent the shell interpreter from parsing (and removing) the escaping or punctuation. | ||
| If the environment variables are being set from a file (such as a docker env-file or in a Kubernetes manifest YAML) then those outermost single-quotes should usually be removed, otherwise renovate may interpret the entire value as a simple string instead of as a compound JSON object. |
There was a problem hiding this comment.
Suggested change
| If the environment variables are being set from a file (such as a docker env-file or in a Kubernetes manifest YAML) then those outermost single-quotes should usually be removed, otherwise renovate may interpret the entire value as a simple string instead of as a compound JSON object. | |
| If the environment variables are being set from a file (such as a Docker env-file or in a Kubernetes manifest YAML) then those _outermost_ single-quotes should be removed. | |
| This prevents Renovate from wrongly interpreting the entire value as a simple string. |
HonkingGoose
suggested changes
Apr 30, 2024
| The config options that you can use in environment variables all have the prefix `RENOVATE_`. | ||
| Most config options can be set using environment variables. | ||
| The environment variable name is usually found by adding the prefix `RENOVATE_` to the config option name in all-uppercase. | ||
| (This prefix can be changed by setting the environment variable `ENV_PREFIX`.) |
There was a problem hiding this comment.
Suggested change
| (This prefix can be changed by setting the environment variable `ENV_PREFIX`.) | |
| (This prefix can be changed by setting the environment variable `ENV_PREFIX`.) |
| You may use synchronous or asynchronous methods inside a `.js` file, including even to fetch config information from remote hosts. | ||
|
|
||
| #### Environment config | ||
|
|
||
| Global config can be defined using environment variables. | ||
| The config options that you can use in environment variables all have the prefix `RENOVATE_`. | ||
| Most config options can be set using environment variables. |
There was a problem hiding this comment.
Suggested change
| Most config options can be set using environment variables. | |
| Most config options can be set using environment variables. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor docs updates, which resulted from the docs additions in #28035 being tested in #28097.
This concerns the configuration overview. Attempts to clarify terminology (or relate to different terminology used elsewhere in the docs), and expand on how environment variables may be used in renovate.