diff --git a/docs/usage/getting-started/private-packages.md b/docs/usage/getting-started/private-packages.md index 02fa5d52259b2d..9007d04028df64 100644 --- a/docs/usage/getting-started/private-packages.md +++ b/docs/usage/getting-started/private-packages.md @@ -261,7 +261,35 @@ The end-result looks like this: Renovate doesn't support reading `npmRegistries` and `npmScopes` from `.yarnrc.yml`, so `hostRules` (or `npmToken`) and `npmrc` should be configured like above. Renovate updates `npmRegistries` in `.yarnrc.yml` with resolved `hostRules` before running Yarn. -For Renovate to overwrite existing `npmRegistries` entry, the key should match the `matchHost` without the protocol (`http:` or `https:`) and with the trailing slash. +For Renovate to overwrite existing `npmRegistries` entry, the key should match the `matchHost` minus the protocol (`http:` or `https:`) plus the trailing slash. + +For example, the Renovate configuration: + +```json +{ + "hostRules": [ + { + "matchHost": "https://npm.pkg.github.com/", + "hostType": "npm", + "encrypted": { + "token": "" + } + } + ] +} +``` + +will update `.yarnrc.yml` as following: + +```yaml +npmRegistries: + //npm.pkg.github.com/: + npmAuthToken: + //npm.pkg.github.com: + # this will not be overwritten and may conflict + https://npm.pkg.github.com/: + # this will not be overwritten and may conflict +``` ### nuget