From d3efe1168f90c3277d8e6e29237d5668be9d2deb Mon Sep 17 00:00:00 2001 From: Matt Lavin <matt.lavin@gmail.com> Date: Fri, 12 Apr 2019 07:14:28 -0400 Subject: [PATCH] docs: Update details of hosting shared configs in GitHub and GitLab (#3529) --- website/docs/config-presets.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/config-presets.md b/website/docs/config-presets.md index 335a9a8912..36a0230cec 100644 --- a/website/docs/config-presets.md +++ b/website/docs/config-presets.md @@ -147,13 +147,11 @@ It is also possible to host your preset config using just a regular GitHub repos To host your preset config on GitHub: - Create a new repository. Normally you'd call it renovate-config but it can be named anything -- Add a renovate.json to this new repo containing the preset config. No other files are necessary. +- Add configuration files to this new repo for any presets you want to share. For the default preset, `default.json` will be checked first and then `renovate.json`. For named presets, `<preset-name>.json` will be loaded. For example, loading preset `library` would load `library.json`. No other files are necessary. - In other repos, reference it in an extends array like "github>owner/name", e.g. "github>rarkins/renovate-config" From then on Renovate will use the renovate config from the preset repo's default branch. You do not need to add it as a devDependency or add any other files to the preset repo. -Note: Unlike npmjs-hosted presets, GitHub-hosted ones can contain only one config. - ## GitLab-hosted Presets It is also possible to host your preset config using just a regular GitLab repository and without needing to publish it to npmjs. In such cases Renovate will simply look for a renovate.json file in the default branch, (for now only the master branch is supported). @@ -164,6 +162,8 @@ To host your preset config on GitLab: - Add a renovate.json to this new repo containing the preset config. No other files are necessary. - In other repos, reference it in an extends array like "gitlab>owner/name", e.g. "gitlab>rarkins/renovate-config" +Note: Unlike npmjs-hosted presets, GitLab-hosted ones can contain only one config. + ## Presets and Private Modules Using your own preset config along with private npm modules can present a chicken and egg problem. You want to configure the encrypted token just once, which means in the preset. But you also probably want the preset to be private too, so how can the other repos reference it? -- GitLab