robwierzbowski / generator-jekyllrb

Supercharge Jekyll development with Yeoman. Yo, Jekyllrb!
BSD 3-Clause "New" or "Revised" License
596 stars 65 forks source link

Deployment options #10

Closed robwierzbowski closed 10 years ago

robwierzbowski commented 11 years ago

The generator needs bult-in deployment commands, or some recommended deployment options in the readme. This issue expands https://github.com/robwierzbowski/generator-jekyllrb/issues/3 to include a discussion of all deployment options.

People will want to deploy to

People will want to deploy by

We can create automated deployment with

We are only uploading/pushing the compiled contents of the dist folder (even to Github pages — the generator's build magic needs Yeoman/Grunt, and can't happen on Github's servers).

Questions

Should the generator set up a deployment task out of the box? Which? More than one? Does anyone have good experiences with a node/grunt ftp/rsync/push task we could use? Any preferences on deployment workflow?

tomlane commented 11 years ago

Offering deployment as a prompt choice might be a safe bet :)

robwierzbowski commented 11 years ago

Dropping some notes here:

Setting up deployment should be a subgenerator, in case you want to run it multiple times.

For Github pages: Set up new repo in dist, if one doesn't exist. Automatic commit messages, or ask user to commit separately? Deploy with deploy or publish command, not with commit.

robwierzbowski commented 11 years ago

The more I think about this, the more I think it's not worth putting in its own task.

Git commit and git push won't be simplified any further by wrapping with a Grunt task. s/Ftp/rsync and uploading to Heroku/S3/Nodejistu already have Grunt plugins written for them, and can be added by an end user.

If anyone wants to collaborate on a Grunt plugin that would deploy to git, s/ftp, rsync, S3, Heroku, etc., all through a single api, I'm up for that. But for git/github.io deployment I don't think a wrapper task is worthwhile.

robwierzbowski commented 11 years ago

After picking apart Octopress I think this is totally doable, but should live in its own Grunt task. Looks like a project for next week.

aliirz commented 11 years ago

@robwierzbowski looking forward to it

ggamel commented 11 years ago

@robwierzbowski This is wonderful news. Anxiously awaiting.

robwierzbowski commented 11 years ago

Lots of updates to the generator and grunt-jekyll this weekend, and I'm working on Jekyll Picture Tag for the beginning of next week, so might not be till next weekend. If anyone with grunt task experience wants to pair I would be into it.

aliirz commented 10 years ago

I am no grunt guru but I would really like to help as I feel the need to build this task as very important. Where can I get started?

robwierzbowski commented 10 years ago

This is my first task for the weekend and shouldn't take too long (last weekend was updating this generator). I'll ping you when I create the new repo — testing and feedback will help a lot.

On Friday, September 13, 2013, Ali Raza wrote:

I am no grunt guru but I would really like to help as I feel the need to build this task as very important. Where can I get started?

— Reply to this email directly or view it on GitHubhttps://github.com/robwierzbowski/generator-jekyllrb/issues/10#issuecomment-24391236 .

Rob Wierzbowski @robwierzbowski http://twitter.com/#!/robwierzbowski http://github.com/robwierzbowski http://robwierzbowski.com

aliirz commented 10 years ago

@robwierzbowski Looking forward :)

kwaledesign commented 10 years ago

pinging on this issue to check on progress. potentially related to issue #29

happy to help out if needed.

robwierzbowski commented 10 years ago

@kwaledesign I don't think the problems are related. If you want to pair on the Grunt dist plugin that would be great. Give me an email, maybe we can set up a quick facetime chat and split up some tasks. Busy day job == lagging behind open source work.

kwaledesign commented 10 years ago

@robwierzbowski definitely willing to pair on this, as I think it's a valuable feature that everyone would appreciate. I personally haven't explored deployment options via grunt, but will dig into that soon.

Will ping you via email, thx ~ Sam.

robwierzbowski commented 10 years ago

Sounds good. I have the functionality and 0.5+ of the work done, just having a hard time finding hours. It would be great to have someone to bounce ux/dx decisions off of too.

robwierzbowski commented 10 years ago

Finally!

Use grunt-build-control to deploy built code to a GitHub pages branch, heroku, or anything really. YAY.

Testing and bug reports welcome. We're using this in production at the company I'm working at so the more edge cases we can find the better.

We can also add it as a generator option in the near future.