knode / node-meatspace

Node.js community resource for encouraging and promoting in-person events.
100 stars 53 forks source link

Building the Meatspace #69

Closed gergelyke closed 10 years ago

gergelyke commented 10 years ago

Added a little pre-commit hook to run the build script, hopefully this way we have a smaller chance to forget it :) Also, an install script is included using Grunt.

mikeal commented 10 years ago

i don't know anything about grunt so if you wanted a "review" someone else should look at it. but go ahead and merge if you're pretty sure it works :)

hackygolucky commented 10 years ago

Yeah, unfortunately I have no experience with grunt. Merge on with your bad self?

On Thu, Jan 2, 2014 at 2:58 PM, Mikeal Rogers notifications@github.comwrote:

i don't know anything about grunt so if you wanted a "review" someone else should look at it. but go ahead and merge if you're pretty sure it works :)

— Reply to this email directly or view it on GitHubhttps://github.com/mikeal/node-meatspace/pull/69#issuecomment-31492442 .

rosskukulinski commented 10 years ago

I also have no grunt experience :-/

On Thu, Jan 2, 2014 at 3:05 PM, Tracy notifications@github.com wrote:

Yeah, unfortunately I have no experience with grunt. Merge on with your bad self?

On Thu, Jan 2, 2014 at 2:58 PM, Mikeal Rogers notifications@github.comwrote:

i don't know anything about grunt so if you wanted a "review" someone else should look at it. but go ahead and merge if you're pretty sure it works :)

— Reply to this email directly or view it on GitHub< https://github.com/mikeal/node-meatspace/pull/69#issuecomment-31492442> .

— Reply to this email directly or view it on GitHubhttps://github.com/mikeal/node-meatspace/pull/69#issuecomment-31492927 .

rosskukulinski commented 10 years ago

Hey @gergelyke - What do you think about adding the modified index.html to the commit with the pre-commit?

I.e.:

#!/bin/sh                                                                                                                              
#run script to build html the page                                                                                                     
node build.js
RETVAL=$?
if [ $RETVAL -ne 0 ]
then
    exit 1
fi
git add index.html

The upside to this is that if you update the readme, the index.html is automatically built and committed (assuming you've installed grunt and ran 'grunt' in the directory to install the git hooks). The downside to this is that developers would never see the updated index.html in their working directory -- it would go from unchanged to committed.

hackygolucky commented 10 years ago

I like any idea that helps us automate--I was trying to figure out a better workflow after merging a PR adding an event and having to run the build script myself.

It is really an automatic process already. I would be concerned at something going horribly wrong and breaking the site temporarily. Is that possible?

On Fri, Jan 3, 2014 at 10:11 AM, Ross Kukulinski notifications@github.comwrote:

Hey @gergelyke https://github.com/gergelyke - What do you think about adding the modified index.html to the commit with the pre-commit?

I.e.:

!/bin/sh

run script to build html the page

node build.js RETVAL=$? if [ $RETVAL -ne 0 ] then exit 1 fi git add index.html

The upside to this is that if you update the readme, the index.html is automatically built and committed (assuming you've installed grunt and ran 'grunt' in the directory to install the git hooks). The downside to this is that developers would never see the updated index.html in their working directory -- it would go from unchanged to committed.

— Reply to this email directly or view it on GitHubhttps://github.com/mikeal/node-meatspace/pull/69#issuecomment-31541391 .

gergelyke commented 10 years ago

@rosskukulinski I think it is a good idea! Sure, it has the downside you mentioned, but the index.html will always reflect the state of the markdown file. I will create another PR, and you can test it out!

rosskukulinski commented 10 years ago

valid concerns - but after looking at how the site is generated I'm not that worried. build.js simply converts the README.md markdown to HTML (and if that conversion fails, the pre-commit hook fails, which keeps you from committing).

@gergelyke I have that exact change in place already, I can submit a PR since I've got it already

gergelyke commented 10 years ago

then please do :+1: