From ea512a95f3d4b19fc12d72b5e283e681d2439c0e Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Thu, 13 Nov 2014 17:47:16 -0500 Subject: [PATCH] Add Heroku push docs --- website/docs/source/layouts/layout.erb | 1 + website/docs/source/v2/push/heroku.html.md | 63 ++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 website/docs/source/v2/push/heroku.html.md diff --git a/website/docs/source/layouts/layout.erb b/website/docs/source/layouts/layout.erb index 0631ad128..315408de5 100644 --- a/website/docs/source/layouts/layout.erb +++ b/website/docs/source/layouts/layout.erb @@ -294,6 +294,7 @@ <% end %> diff --git a/website/docs/source/v2/push/heroku.html.md b/website/docs/source/v2/push/heroku.html.md new file mode 100644 index 000000000..dc730dc62 --- /dev/null +++ b/website/docs/source/v2/push/heroku.html.md @@ -0,0 +1,63 @@ +--- +page_title: "Vagrant Push - Heroku Strategy" +sidebar_current: "push-heroku" +description: |- + The Vagrant Push Heroku strategy pushes your application's code to Heroku. + Only files which are committed to the Git repository are pushed to Heroku. +--- + +# Vagrant Push + +## Heroku Strategy + +[Heroku][] is a public IAAS provider that makes it easy to deploy an +application. The Vagrant Push Heroku strategy pushes your application's code to +Heroku. + +
+

+ Warning: The Vagrant Push Heroku strategy requires you + have configured your Heroku credentials and created the Heroku application. + This documentation will not cover these prerequisites, but you can read more + about them in the Heroku documentation. +

+
+ +Only files which are committed to the Git repository will be pushed to Heroku. +Additionally, the current working branch is always pushed to the Heroku, even if +it is not the "master" branch. + +The Vagrant Push Heroku strategy supports the following configuration options: + +- `app` - The name of the Heroku application. If the Heroku application does not + exist, an exception will be raised. If this value is not specified, the + basename of the directory containing the `Vagrantfile` is assumed to be the + name of the Heroku application. Since this value can change between users, it + is highly recommended that you add the `app` setting to your `Vagrantfile`. + +- `dir` - The base directory containing the Git repository to upload to Heroku. + By default this is the same directory as the Vagrantfile, but you can specify + this if you have a nested Git directory. + +- `remote` - The name of the Git remote where Heroku is configured. The default + value is "heroku". + + +### Usage + +The Vagrant Push Heroku strategy is defined in the `Vagrantfile` using the +`heroku` key: + +```ruby +config.push.define "heroku" do |push| + push.app = "my_application" +end +``` + +And then push the application to Heroku: + +```shell +$ vagrant push +``` + +[Heroku]: https://heroku.com/ "Heroku"