-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Update README.md #153
Update README.md #153
Conversation
Enterprise github hostname in documentation.
Codecov Report
@@ Coverage Diff @@
## master #153 +/- ##
=======================================
Coverage 64.14% 64.14%
=======================================
Files 41 41
Lines 1969 1969
=======================================
Hits 1263 1263
Misses 641 641
Partials 65 65 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Yes this is much easier. Just one small comment.
README.md
Outdated
@@ -392,6 +398,7 @@ $ atlantis server --atlantis-url $URL --gitlab-user $USERNAME --gitlab-token $TO | |||
- `$USERNAME` is the GitHub/GitLab username you generated the token for | |||
- `$TOKEN` is the access token you created. If you don't want this to be passed in as an argument for security reasons you can specify it in a config file (see [Configuration](#configuration)) or as an environment variable: `ATLANTIS_GH_TOKEN` or `ATLANTIS_GITLAB_TOKEN` | |||
- `$SECRET` is the random key you used for the webhook secret. If you left the secret blank then don't specify this flag. If you don't want this to be passed in as an argument for security reasons you can specify it in a config file (see [Configuration](#configuration)) or as an environment variable: `ATLANTIS_GH_WEBHOOK_SECRET` or `ATLANTIS_GITLAB_WEBHOOK_SECRET` | |||
- `$GITHUBHOSTNAME` is the URL of your enterprise Github |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you give an example here? So people know if it should contain the scheme or not (it shouldn't). Like:
... is the URL of your enterprise GitHub, ex. github.mycompany.com (don't add https://).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
example update for gh-hostname parameter
Thanks! |
Test github_comment_renderer
Enterprise github hostname in documentation. I mean it is not too hard to find it in the codebase, but it is nicer here.