Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clearer documentation for GitHub Enterprise #875

Closed
geotrev opened this issue Mar 8, 2022 · 2 comments
Closed

Clearer documentation for GitHub Enterprise #875

geotrev opened this issue Mar 8, 2022 · 2 comments

Comments

@geotrev
Copy link

geotrev commented Mar 8, 2022

Hello there,

I'm using release-it on GH Enterprise and noticed there isn't very clear documentation on how to set a configuration for it.

My GHE instance uses a non-github URL, so based on the sourcecode, would this be correct?

{
  "release-it": {
    "github": {
      "host": "private.source.com"
    }
  }
}

Which results in https://private.source.com/api/v3.

If this looks right, I'm happy to make a PR that specifies the right keys in the README or github release doc. Right now there's no mention of them as far as I can tell, except by source code and looking at the base config schema in config/.release-it.json.

Thanks!

@webpro
Copy link
Collaborator

webpro commented Mar 21, 2022

Just added 6d7c3f2

Does this help? Happy to receive a PR for anything else that's not clear :)

@geotrev
Copy link
Author

geotrev commented Mar 21, 2022

That's great, thank you!

@geotrev geotrev closed this as completed Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants