(PDOC-121) Include tag or SHA in gh_pages task commit #121
Conversation
This file contains hidden or 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
scotje
reviewed
Nov 3, 2016
| @@ -37,13 +44,14 @@ | |||
| task :push do | |||
| Dir.chdir('doc') do | |||
| system 'git add .' | |||
| system "git commit -m '[strings] Generated Documentation Update'" | |||
| system "git commit -m '[strings] Generated Documentation Update at Revision #{@git_sha}'" | |||
There was a problem hiding this comment.
Should the :push task just depend on the :get_sha task in case someone runs it directly?
There was a problem hiding this comment.
ah, I hadn't thought of that. Good idea :D
whopper
force-pushed
the
PDOC-121/master/gh_pages_sha
branch
from
ce56ed2 to
8b58c26
Compare
scotje
reviewed
Nov 3, 2016
| system 'git push origin gh-pages -f' | ||
| end | ||
| end | ||
|
|
||
| desc 'Run checkout, generate, and push tasks.' | ||
| task :update => [ | ||
| :get_sha, |
There was a problem hiding this comment.
don't know that it hurts anything but this is probably unnecessary now
whopper
force-pushed
the
PDOC-121/master/gh_pages_sha
branch
2 times, most recently
from
ad8be3c to
66f750c
Compare
|
@scotje updated again |
whopper
force-pushed
the
PDOC-121/master/gh_pages_sha
branch
from
66f750c to
3a6222c
Compare
scotje
reviewed
Nov 3, 2016
| system 'git push origin gh-pages -f' | ||
| end | ||
| end | ||
|
|
||
| desc 'Run checkout, generate, and push tasks.' | ||
| desc 'Run checkout, generate, configure, and push tasks.' |
There was a problem hiding this comment.
One last thing, we should probably make this description just say "update docs and push to github" or something like that, since we aren't advertising the underlying tasks anymore.
This commit updates the gh_pages task to reference the SHA of the branch being documented in the documentation commit. In addition, the description of each task except `update` has been removed, as they are not useful on their own and should be considered private. This is necessary in order to hide the tasks from the output of `rake -T`.
whopper
force-pushed
the
PDOC-121/master/gh_pages_sha
branch
from
3a6222c to
05806e7
Compare
scotje
approved these changes
Nov 3, 2016
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.
This commit updates the gh_pages task to reference the SHA
of the branch being documented in the documentation commit.
In addition, the description of each task except
updatehas been removed, as they are not useful on their own and
should be considered private. This is necessary in order
to hide the tasks from the output of
rake -T.