Clarify the github.host config option (#875)

release-it · Mar 21, 2022 · 6d7c3f2 · 6d7c3f2
1 parent f7ed5e3
commit 6d7c3f2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/github-releases.md b/docs/github-releases.md
@@ -107,6 +107,9 @@ In case the release should not be made public yet, set `github.draft: true`.
 
 Use a different host from what would be derived from the Git url (e.g. when using GitHub Enterprise).
 
+By default, the GitHub API host is https://api.github.com. Setting `github.host` to `"private.source.com"` would result
+in release-it using https://private.source.com/api/v3.
+
 ## Proxy
 
 In case release are done from behind a proxy, set `github.proxy` using a string to a proxy address like