README.md in heroku_ops-0.0.4 vs README.md in heroku_ops-0.0.5
- old
+ new
@@ -4,19 +4,27 @@
* pipeline/app setup
* db restore (pull down your heroku database and `psql < tmp/latest.db`)
* deploys (push to heroku remotes)
-These tasks all assume your heroku application names are of the format `"#{Rails.application.class.parent_name.underscore.gsub('_','-')}-#{environment}"`, where environment is one of staging, production. Setting up an app includes the following free Heroku addons:
+These tasks will use the two following environment variables to determine your staging and production app names:
-*heroku-postgresql:hobby-dev
-*newrelic:wayne
-*papertrail:choklad
-*rediscloud:30
-*scheduler:standard
-*sendgrid:starter
+If these variables aren't present, it will default to the following format:
+`"#{Rails.application.class.parent_name.underscore.gsub('_','-')}-#{environment}"`
+
+## Addons
+
+Setting up an app includes the following free Heroku addons:
+
+* heroku-postgresql:hobby-dev
+* newrelic:wayne
+* papertrail:choklad
+* rediscloud:30
+* scheduler:standard
+* sendgrid:starter
+
App name configuration flags and more detailed documentation will come in a later version.
## Installation
@@ -33,36 +41,40 @@
Or install it yourself as:
$ gem install heroku_ops
## Usage
-To see an updated list of tasks and descriptions:
+To see an updated list of tasks and descriptions implemented in this gem:
`bundle exec rake heroku_ops -T heroku_ops`
~~~bash
-rake heroku_ops:db:restore # Pull Down a copy of the database from the specified heroku environment
-rake heroku_ops:db:restore:from_local_dump # Restore from local dump file (defaults to '/tmp/latest.dump' - specify with DUMP_FILE Environmental Variable)
-rake heroku_ops:db:restore:local # Erase local development and test database and restore from the local dump file
-rake heroku_ops:db:restore:production # Restore a local copy of Heroku's Production Environment database
-rake heroku_ops:db:restore:staging # Restore a local copy of Heroku's Staging Environment database
-rake heroku_ops:deploy # Deploy Safely to Heroku
-rake heroku_ops:deploy:production # Deploy to Heroku's Production Environment
-rake heroku_ops:deploy:production:quick # Quick Deploy to Production, without running migrations
-rake heroku_ops:deploy:staging:quick # Quick Deploy to Staging, without running migrations
+rake db:restore # Pull Down a copy of the database from the specified heroku environment
+rake db:restore:from_local_dump # Restore from local dump file (defaults to '/tmp/latest.dump' - specify with DUMP_FILE Environmental Variable)
+rake db:restore:local # Erase local development and test database and restore from the local dump file
+rake db:restore:production # Restore a local copy of Heroku's Production Environment database
+rake db:restore:staging # Restore a local copy of Heroku's Staging Environment database
+rake deploy # Deploy Safely to Heroku
+rake deploy:production # Deploy to Heroku's Production Environment
+rake deploy:production:quick # Quick Deploy to Production, without running migrations
+rake deploy:staging:quick # Quick Deploy to Staging, without running migrations
rake heroku_ops:pipeline:setup # Create a pipeline, staging and production applications
rake heroku_ops:pipeline:setup:pipeline # Setup a pipeline with your applications in the appropriate stages
rake heroku_ops:pipeline:setup:production # Setup a production app (with addons) and git remote for heroku
rake heroku_ops:pipeline:setup:staging # Setup a staging app (with addons) and remote for heroku
~~~
+## Dependencies
+The `db` and `deploy` tasks rely on the following two gems:
+* https://github.com/ldstudios/heroku_rake_deploy
+* https://github.com/ldstudios/heroku_db_restore
+
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/nrowegt/heroku_ops.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-Thanks to [@danielricecodes](http://www.ldstudios.co/) for the inspiration and the initial base implementations of the restore and deploy tasks.