GitHub Pages Deploy Plugin

[balupton]

After a generate has finished, it should wipe the gh-pages branch, copy the contents of the original out directory into it, add the changes, commit them, and check back to the original branch.

[balupton]

Continued here: #385

[deitch]

I'll take the combination of @sergeylukin and my script and make it a plugin. Please send me link on how I write a plugin that extends the docpad command and I'll make it happen. I know how to do a generic plugin, not a docpad command extending one.

[sergeylukin]

Sounds like a good plan:) I think at least 1 config variable should be available: branch name. That's because Github use "gh-pages" branch for project repos and "master" branch for user/organization repos.

[balupton]

Alright I've created https://github.com/docpad/docpad-plugin-ghpages and given you both push + pull access. It appears however that the consoleSetup event is not fired as it should have been. I'll look into this when I get some more time - feel free to look into it yourselves though.

[balupton]

Okay it seems the issue is that the plugins are not loaded at the time that event is fired. Looking into it, it is due to the load:false here - https://github.com/bevry/docpad/blob/master/src/bin/docpad.coffee#L6 - changing that to load:true makes it work, however I'm sure there is real good reason why that is there. Should be looked into.

For now, just make that load:true so you can continue development on this plugin. Instructions on how you can work on the docpad core are inside the CONTRIBUTING.md file.

[deitch]

Cool. I like how that works, looking at your template.

So everything that has to happen can boil down to:

1. docpad generate
2. cd to ./out
3. git stuff
4. clean up rm -rf .git
5. cd back to ../

1 is covered via docpad.action 'generate', {env:opts.environment}. 2 & 5 are easy to cover with cwd. 4 is coverable with rimraf. The remaining question is the git stuff.

Two options:

1. wrap the user's command-line git. Depends on the local install, but you know it will inherit all of the user's prefs (and ssh keys, etc.)
2. use a native node git client

Preferences?

[deitch]

Separately: if we have direct push/pull access on the repo, would you prefer a separate repo deitch/docpad-plugin-ghpages and I issue a pull request to it and then pull, or that I work directly against docpad/docpad-plugin-ghpages ?

[sergeylukin]

Regarding git stuff I was thinking about something like that:

var exec = require('child_process').exec,
     remote_repo = exec('git config remote.origin.url', function() {}),
     remote_branch = 'gh-pages',
     git_command = 'git init' +
                             ' && git add .' +
                             " && git commit -m 'build'" +
                             ' && git push ' + remote_repo + ' master:' + remote_branch + ' --force' +
                             '';
// Execute git commands
exec(git_command,
  function (error, stdout, stderr) {
    console.log('stdout: ' + stdout);
    console.log('stderr: ' + stderr);
    if (error !== null) {
      console.log('exec error: ' + error);
    }
});

What do you think?

[deitch]

Heh, I just finished writing something almost exactly like that! :-) Along with README.md, etc.

Except that getting the remote_repo that way doesn't work, since exec() returns the child_process, not the output of stdout.

Hold on, I will push the interim changes out to the repo that @balupton just gave us access to, we can both work from there.

[deitch]

Huh! I try, but github isn't accepting my push.

In the repo page on the Web, I see the URLs show read+write access, and I have ssh, so I push easily to all my other repos, but this one, when I do, it says:

# git push origin master
Username:
Password:

Weird?

[balupton]

Could be that you cloned the HTTPS rather the SSH address

[deitch]

You're right, I did. But looking at the addresses, it shows R/W for both of them.

I'll change it anyways and try.

[deitch]

Yeah, that did it. Strange how it didn't take it, though.

[deitch]

BTW, what I pushed to the repo was barely reviewed, more like pseudo-coffee-code than code. Just trying to get it into the hands of the rest here.

[deitch]

Something strange here. I modified my local install to load:true so that I get the modules. Fine.

When I do, I get an error

warning: An error occured: 
Error: Cannot find module '/...../node_modules/docpad-plugin-ghpages'
    at Function._resolveFilename (module.js:332:11)
    at Function._load (module.js:279:25)
    at Module.require (module.js:354:17)
    at require (module.js:370:17)
    at PluginLoader.load (/Users/adeitcher/local/lib/node_modules/docpad/out/lib/plugin-loader.js:144:26)

But I know it is installed locally. I run npm ls and it is there??

[deitch]

Never mind, my own mistake. Ignore.

[deitch]

OK, question: you use

docpad.action 'generate'

How do I make it the equivalent of docpad generate --env static ? I tried

docpad.action 'generate', {env:opts.environment or 'static'}

But it didn't work, even though opts.environment was undefined.

[deitch]

Hmm, even stranger. It seems to completely ignore the env option after the docpad instance is already created.

[deitch]

Weird, but I got it. You need to set commander.env = 'static' for it to work.

Now I cannot get it any further without having load:false to make sure it works.

Also the tests have an empty frame, but are non-existent.

[sergeylukin]

Nice work! Looks good so far.

[balupton]

AWESOME. This progressed way fast! I applied some improvements with docpad/docpad-plugin-ghpages@b89c29c so now just to figure out that loading issue!

So cool!

[deitch]

Well, not much point in waiting, is there? Might as well do it while it is fresh in all our minds.

[deitch]

LOL! "... too scary for the average user... "

[zenorocha]

Looking forward to use this plugin on my docpad projects :)

[balupton]

Alrighty, I've got the necessary changes in DocPad going, just need to do some more testing. Changes here: master...dev-loadearly

Note these changes: 070f9b9#L0R5 - initially I'll do this only when deploy is mentioned in our command, and see how that goes. Just unsure what a double load at this point will do if I enable it for all commands. If it doesn't cause any issue, we can look at making it happen all the time when needed.

[deitch]

I came across one issue. If you have the livereload plugin, set {load: true}, and run docpad generate --env static, then the livereload JS is still included in the output files. Normally --env static should preclude the livereload JS from being there.

[deitch]

Hey @balpton, how goes this issue? Happy to have done the work, but want it to benefit.

[balupton]

Fixed the loading issue, however just got back from holidays so haven't had a chance to push it all up. Will be coming soon.

[balupton]

Done.

v2.0.0 of docpad-plugin-ghpages now out
v6.24.0 of docpad now out

🍰

Well done everyone! Great team effort :) 👍

[deitch]

Awesome @balupton really was a great team effort.

Do you need 6.24.0 or higher to use it?

[balupton]

Yes.