Noveku
A collection of aliases we use when interacting with heroku. This gem was inspired by a collection of thoughtbot aliases.
Prerequisites
Ruby 1.9+ only. This gem depends on novelys/gomon. However, the presence of the command heroku
(either via the gem, or the toolbelt) is assumed
Installation
gem install noveku
. Since it will not be part of your application, only of your workflow,
you should install it globally, not via bundler and your project's Gemfile.
Usage
noveku ENV commands...
: will execute the given commands for the ENV
remote.
We strongly suggest adding shell aliases for convenience :
alias nvp='noveku production'
alias nvs='noveku staging'
Heroku commands
Supported commands and their equivalent :
rake
:heroku run rake ARGS --remove ENV
console
:heroku run console --remote ENV
migrate
:heroku run rake db:migrate --remote ENV && heroku restart --remote ENV
tail
:heroku logs --tail --remote ENV
When giving a command that is not specifically supported, it will be passed to heroku
: heroku ARGS --remote ENV
.
This makes several other commands available, such as restart
, releases
, ps
, open
...
Advanced commands
mongodump
: Dumps the mongo database. Shortcut for bothmongolab_dump
andmongohq_dump
: tries mongolab first, then mongohq.mongolab_dump
: Dumps the mongo database. Look in the config keys ofENV
to findMONGOLAB_URI
.mongohq_dump
: Dumps the mongo database. Look in the config keys ofENV
to findMONGOHQ_URL
.
Those commands put the dump in the dump
dir, relatively to where you executed it.
Since the restoration of the database does not involve any interaction with heroku, it is out of the scope of this gem at the moment. However, this gem depends on novelys/gomon, which includes a class wrapping mongodump/restore, making it very easy to use in a rake task.
What's next
I plan on adding a command allowing you to create a heroku app, setup your addons, update your git config, create a local branch if needed.. all that in one step. We're still thinking about what the command api will look like. This will probably be the last feature before tagging 1.0.0.
Contributions
- Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. In the first case, please include a use-case.
- Fork the repository on Github, make a feature branch, work on this branch.
- If necessary, write a test which shows that the bug was fixed or that the feature works as expected.
- Send a pull request and annoy us until we notice it. :)
Changelog
0.5
: Test coverage, check the presence of environment & that it matches a heroku app, that pwd is a heroku app, the presence of mongohq/lab uri.0.4
: Requiregomon
for mongodump, changed executable names, internal refactoring.0.3
: Addedmongodump
,mongolab_dump
,mongohq_dump
.0.2
: Addedrake
command.0.1
: First version. Available commands :console
,migrate
,tail
.