Skip to content

Commit ab7f7ee

Browse files
docs: add basic provider options to the readme
1 parent 43de75a commit ab7f7ee

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@
55

66
The GitHub provider for [go-semantic-release](https://github.com/go-semantic-release/semantic-release).
77

8+
### Provider Option
9+
10+
The provider options can be configured via the `--provider-opt` CLI flag.
11+
12+
| Name | Description | Example |
13+
|---|---|---|
14+
| github_enterprise_host | This configures the provider to use a GitHub Enterprise host endpoint | `--provider-opt github_enterprise_host=github.mycorp.com` |
15+
| github_use_compare_commits | This enables the [compare commits API](https://docs.github.com/en/rest/reference/repos#compare-two-commits) for fetching the commits | `--provider-opt github_use_compare_commits=true` |
16+
817
## Licence
918

1019
The [MIT License (MIT)](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)