Skip to content

Instructions for setting SYMFONY_ENV on Heroku #4591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 6, 2014
Merged

Instructions for setting SYMFONY_ENV on Heroku #4591

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f987ff
instructions for setting SYMFONY_ENV on Heroku for smooth deploys
dzuelke Dec 4, 2014
579fdd6
capitalize section title as per feedback
dzuelke Dec 5, 2014
576bbfb
remove first person as per feedback
dzuelke Dec 5, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions cookbook/deployment/heroku.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,9 @@ Deploying your Application on Heroku

To deploy your application to Heroku, you must first create a ``Procfile``,
which tells Heroku what command to use to launch the web server with the
correct settings. After you've done that, you can simply ``git push`` and
you're done!
correct document root. After that, you will ensure that your Symfony application
runs the ``prod`` environment, and then you'll be ready to ``git push`` to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our standard is to not use Oxford commas.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But this is a subordinate clause, not a list of items, no?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm actually not completely sure. Maybe our native speaker @weaverryan can make it clear.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dzuelke what do you mean by:

you will ensure that your Symfony application runs the prod environment

I mean, does the user need to do something here? Or do we just mean, double-check that things are ok when you go to app.php locally, just to be sure first? I'm just not sure myself, so I want it to be clear for others :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bah, nevermind - now I see the next section... - let me read the rest

Heroku for your first deploy!

Creating a Procfile
~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -110,6 +111,27 @@ create the ``Procfile`` file and to add it to the repository:
[master 35075db] Procfile for Apache and PHP
1 file changed, 1 insertion(+)

Setting the ``prod`` environment
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"environment" has to start with a capital "E" (the standard is to capitalize all words except of closed-class words).

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

During a deploy, Heroku runs ``composer install --no-dev`` to install all of the
dependencies your application requires. However, typical `post-install-commands`_
in ``composer.json``, e.g. to install assets or clear (or pre-warm) caches, run
using Symfony's ``dev`` environment by default.

This is clearly not what you want - the app runs in "production" (even if you
use it just for an experiment, or as a staging environment), and so any build
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

serial comma again

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this a subordinate clause, not an enumeration?

steps should use the same ``prod`` environment as well.

Thankfully, the solution to this problem is very simple: Symfony will pick up an
environment variable named ``SYMFONY_ENV`` and use that environment if nothing
else is explicitly set. As Heroku exposes all `config vars`_ as environment
variables, we can issue a single command to prepare our app for a deployment:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually we avoid the first person perspective. I think we should stick with that here too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, "you" instead of "we", sure, sorry!


.. code-block:: bash

$ heroku config:set SYMFONY_ENV=prod

Pushing to Heroku
~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -193,3 +215,5 @@ You should be seeing your Symfony application in your browser.
.. _`ephemeral file system`: https://devcenter.heroku.com/articles/dynos#ephemeral-filesystem
.. _`Logplex`: https://devcenter.heroku.com/articles/logplex
.. _`verified that the RSA key fingerprint is correct`: https://devcenter.heroku.com/articles/git-repository-ssh-fingerprints
.. _`post-install-commands`: https://getcomposer.org/doc/articles/scripts.md
.. _`config vars`: https://devcenter.heroku.com/articles/config-vars