up-hook is an up middleware that
enables zero-downtime reloads upon pushing to a GitHub repository
through a git-hook.
How to use
Add the up-hook middlewarevar uphook = ;srv;
In this case it's set up so that when you push to the
masterbranch, it will run
make deployand, if successful, it'll reload the server.
Add the post-receive hook on GitHub
On GitHub, configure a post-receive hook pointing to the URL supplied in the middleware (e.g:
Running the example
- Create a new GitHub repository and copy the contents of
- Deploy the app by running
DEBUG="up-hook" node server.
- Load the page, it should say "Hi"
- Point a GitHub post-receive hook to "yourdomain.com/tobi"
- Commit some changes to
app.jsand push to master (eg: turn "Hi" into "Bye")
- Your server will have been reloaded!
url: secret url (path + query string) to capture
opts: options object
String|falsebranch to capture (
Stringcommand to execute (
Stringoptional dir to execute process in
fnis called with an error if the command fails, or
nullif the reload is triggered
Copyright (c) 2012 LearnBoost <firstname.lastname@example.org>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.