docs: correct GITHUB_CUSTOM_API_URL format #1991
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the README.md file the example value of `GITHUB_CUSTOM_API_URL` for usage on GHES ends in a `api/v3/` this is incorrect, instead `api/v3` needs to be used. Also it states that the defautl value is `api.github.com`, the true default value is `https://api.github.com`, this again is confusing whether or not the `https` needs to be included or not (it does need to be included)
patrickhuy
requested review from
admiralAwkbar,
ferrarimarco,
GaboFDC,
Hanse00,
jwiebalk,
nemchik and
zkoppert
as code owners
admiralAwkbar
approved these changes
Sep 27, 2021
admiralAwkbar
previously approved these changes
Sep 27, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #
Proposed Changes
In the README.md file the example value of
GITHUB_CUSTOM_API_URLfor usage on GHES ends in aapi/v3/this is incorrect, insteadapi/v3needs to be used. Also it states that the defautl value isapi.github.com, the true default value ishttps://api.github.com, this again is confusing whether or not thehttpsneeds to be included or not (it does need to be included)Readiness Checklist
Author/Contributor
Reviewing Maintainer
breakingif this is a large fundamental changeautomation,bug,documentation,enhancement,infrastructure, orperformance