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

Update README.md #153

Merged
merged 3 commits into from
Jun 26, 2018
Merged

Update README.md #153

merged 3 commits into from
Jun 26, 2018

Conversation

n-marton
Copy link
Contributor

Enterprise github hostname in documentation. I mean it is not too hard to find it in the codebase, but it is nicer here.

Enterprise github hostname in documentation.
@codecov
Copy link

codecov bot commented Jun 20, 2018

Codecov Report

Merging #153 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9e5f57a...eeac678. Read the comment docs.

Copy link
Member

@lkysow lkysow left a 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
Copy link
Member

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://).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

n-marton and others added 2 commits June 23, 2018 09:47
example update for gh-hostname parameter
@lkysow lkysow merged commit cd9ce0e into runatlantis:master Jun 26, 2018
@lkysow
Copy link
Member

lkysow commented Jun 26, 2018

Thanks!

meringu pushed a commit to meringu/atlantis that referenced this pull request May 29, 2023
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

Successfully merging this pull request may close these issues.

2 participants