diff --git a/docs/usage/getting-started/private-packages.md b/docs/usage/getting-started/private-packages.md index 8b576ddd48ea9a260d7bcd93c8b7d5723030fa0a..c862a1641aa344fccb3e59a778cf48870d0ee580 100644 --- a/docs/usage/getting-started/private-packages.md +++ b/docs/usage/getting-started/private-packages.md @@ -111,7 +111,7 @@ Renovate will use those credentials for all requests to `org/repo`. #### Example for gomod -Here's an example for `gomod` with private github.com repos. +Here's an example for `gomod` with private `github.com` repos. Assume this config is used on the `github.com/some-other-org` repo: ```json @@ -150,7 +150,7 @@ When Renovate creates Pull Requests, its default behavior is to locate and embed These release notes are fetched from the source repository of packages and not from the registries themselves, so if they are private then they will require different credentials. When it comes to open source, most packages host their source on `github.com` in public repositories. -GitHub greatly rate limits unauthenticated API requests, so you need to configure credentials for github.com or the bot will get rate limited quickly. +GitHub greatly rate limits unauthenticated API requests, so you need to configure credentials for `github.com` or the bot will get rate limited quickly. It can be confusing for people who host their own source code privately to be asked to configure a `github.com` token but without it Release Notes for most open source packages will be blocked. Currently the preferred way to configure `github.com` credentials for self-hosted Renovate is: