From 137b17d1f119f7fcce1f33e23763b204740d1248 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Fri, 21 May 2021 11:55:04 +0200 Subject: [PATCH] docs: shareable configs only work with JSON format --- docs/development/shareable-configs.md | 1 + docs/usage/config-presets.md | 2 ++ docs/usage/configuration-options.md | 1 + readme.md | 2 +- 4 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/development/shareable-configs.md b/docs/development/shareable-configs.md index 906d0b0b4b4c9d..2c661995acc350 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 4fce6df84f8c48..d57049436cfb98 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 3184ba17df120b..cae189ab710c46 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 dd2f2ecf68b505..f5ec9e8046b2ac 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