diff options
| author | HonkingGoose <[email protected]> | 2021-05-21 18:16:22 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-05-21 16:16:22 +0000 |
| commit | 5f325748b1ea406764b74354fa121d259982d901 (patch) | |
| tree | d078f36c3576197144e07e28eef104df60954b2d | |
| parent | 66494452f1ebdb23d808151caf9cf0d4beaad8e2 (diff) | |
| download | renovate-5f325748b1ea406764b74354fa121d259982d901.tar.gz renovate-5f325748b1ea406764b74354fa121d259982d901.zip | |
docs: shareable configs only work with JSON format (#10100)
Co-authored-by: Jamie Magee <[email protected]>
| -rw-r--r-- | docs/development/shareable-configs.md | 1 | ||||
| -rw-r--r-- | docs/usage/config-presets.md | 2 | ||||
| -rw-r--r-- | docs/usage/configuration-options.md | 1 | ||||
| -rw-r--r-- | readme.md | 2 |
4 files changed, 5 insertions, 1 deletions
diff --git a/docs/development/shareable-configs.md b/docs/development/shareable-configs.md index 906d0b0b4b4..2c661995acc 100644 --- a/docs/development/shareable-configs.md +++ b/docs/development/shareable-configs.md @@ -7,6 +7,7 @@ Unlike ESLint though: - Shared config files can contain many presets Presets can be defined using either npm packages, or with GitHub/GitLab repositories. +Only the JSON format is supported. Bitbucket-hosted presets are yet to be implemented. ## Preset config URIs diff --git a/docs/usage/config-presets.md b/docs/usage/config-presets.md index 4fce6df84f8..d57049436cf 100644 --- a/docs/usage/config-presets.md +++ b/docs/usage/config-presets.md @@ -14,6 +14,8 @@ In short: - Browse [Renovate's default presets](https://docs.renovatebot.com/presets-default/) to find any that are useful to you - Publish your own if you wish to reuse them across repositories +Shareable config presets can only be used with the JSON format, other formats are not supported. + ## Goals of Preset Configs The main reason for supporting preset configs is to decrease duplication. diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 3184ba17df1..cae189ab710 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -24,6 +24,7 @@ Renovate always uses the config from the repository's default branch, even if th Renovate does not read/override the config from within each base branch if present. Also, be sure to check out Renovate's [shareable config presets](./config-presets.md) to save yourself from reinventing any wheels. +Shareable config presets only work with the JSON format. If you have any questions about the config options, or want to get help/feedback about a config, go to the [discussions tab in the Renovate repository](https://github.com/renovatebot/renovate/discussions) and start a new "config help" discussion. We will do our best to answer your question(s). diff --git a/readme.md b/readme.md index dd2f2ecf68b..f5ec9e8046b 100644 --- a/readme.md +++ b/readme.md @@ -16,7 +16,7 @@ Multi-platform and multi-language. - Define schedules to avoid unnecessary noise in projects (e.g. for weekends or outside of working hours, or weekly updates, etc.) - Relevant package files are discovered automatically (e.g. supports monorepo architecture such as Lerna or Yarn workspaces without further configuration) - Bot behavior is extremely customizable via configuration files (config as code) -- Use ESLint-like shared config presets for ease of use and simplifying configuration +- Use ESLint-like shared config presets for ease of use and simplifying configuration (JSON format only) - Lock files are natively supported and updated in the same commit, including immediately resolving conflicts whenever PRs are merged - Supports GitHub (.com and Enterprise), GitLab (.com and CE/EE), Bitbucket Cloud, Bitbucket Server, Azure DevOps and Gitea. - Open source (installable via npm/Yarn or Docker Hub) so can be self-hosted or used via GitHub App |