Check for CNAME file when using gh-deploy #285
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
| # This GitHub pages repository has a CNAME configured. | ||
| with(open('CNAME', 'r')) as f: | ||
| cname_host = f.read() | ||
| print('Your documentation should be available shortly at: http://' + cname_host) |
There was a problem hiding this comment.
Would it make more sense to return here rather than indenting everything below?
|
Good point. I'll go adjust. |
2876a97 to
31427fe
Compare
|
@d0ugal That simplified it a bit. ;) Let me know how that looks. |
|
The messaging should also keep in mind that the CNAME file doesn't garuntee it'll be at that hostname. Might we want a 'Assuming your DNS records are setup correctly' prefix? |
31427fe to
cd3d680
Compare
|
Another good point. One would assume they would already be configured but... |
| @@ -14,7 +14,18 @@ def gh_deploy(config): | |||
| except: | |||
| return | |||
|
|
|||
| # TODO: Also check for CNAME file | |||
| # Does this repository have a CNAME set for GitHub pages? | |||
| cname_host = None | |||
|
One minor nit, otherwise LGTM. |
If a CNAME file exists in the gh-pages branch, we should read it and use that URL as the expected GitHub pages location. For branches without a CNAME file, we will try to determine the URL using the origin URL.
cd3d680 to
6b558dd
Compare
|
Awesome. Just fixed that. |
d0ugal
added a commit
that referenced
this pull request
Dec 16, 2014
Check for CNAME file when using gh-deploy
|
Thanks! |
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.
If a CNAME file exists in the gh-pages branch, we should read it and use that URL as the expected GitHub pages location. For branches without a CNAME file, we will try to determine the URL using the origin URL.