From 402f5d49e75e2004e1507c3e953ebd0c32223732 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 09:43:26 +0200 Subject: [PATCH 01/15] Added a new articule about using/installing inestable Symfony versions --- cookbook/index.rst | 1 + cookbook/install/index.rst | 7 ++ cookbook/install/inestable_versions | 95 +++++++++++++++++++ cookbook/install/upgrading.rst | 141 ++++++++++++++++++++++++++++ cookbook/map.rst.inc | 8 ++ 5 files changed, 252 insertions(+) create mode 100644 cookbook/install/index.rst create mode 100644 cookbook/install/inestable_versions create mode 100644 cookbook/install/upgrading.rst diff --git a/cookbook/index.rst b/cookbook/index.rst index 3587d3e4efd..98828a56287 100644 --- a/cookbook/index.rst +++ b/cookbook/index.rst @@ -18,6 +18,7 @@ The Cookbook event_dispatcher/index form/index frontend/index + install/index logging/index profiler/index request/index diff --git a/cookbook/install/index.rst b/cookbook/install/index.rst new file mode 100644 index 00000000000..dc0f2c4212f --- /dev/null +++ b/cookbook/install/index.rst @@ -0,0 +1,7 @@ +Install and Upgrade +=================== + +.. toctree:: + :maxdepth: 2 + + upgrading diff --git a/cookbook/install/inestable_versions b/cookbook/install/inestable_versions new file mode 100644 index 00000000000..e9957c1b11f --- /dev/null +++ b/cookbook/install/inestable_versions @@ -0,0 +1,95 @@ +How to Install and Use an Inestable Symfony Version +=================================================== + +Symfony releases two new minor versions (2.5, 2.6, 2.7, etc.) per year, one in +May and one in November (:doc:`see releases detail `). +Testing the new Symfony versions in your projects as soon as possible is important +to ensure that they will keep working as expected. + +In this article you'll learn how to install and use new Symfony versions before +they are released as stable versions. + +Creating a New Project Based on an Inestable Symfony Version +------------------------------------------------------------ + +Suppose that Symfony 2.7 version hasn't been released yet and you want to create +a new project to test its features. First, :doc:`install Composer ` +package manager. Then, open a command console, enter your projects directory and +execute the following command: + +.. code-block:: bash + + $ composer create-project symfony/framework-standard-edition my_project "2.7.*" --stability=dev + +Once the command finishes its execution, you'll have a new Symfony project created +in the ``my_project/`` directory and based on the most recent code found in the +``2.7`` branch. + +If you want to test a beta version, use ``beta`` as the value of the ``stability`` +option: + +.. code-block:: bash + + $ composer create-project symfony/framework-standard-edition my_project "2.7.*" --stability=beta + +Upgrading your Project to an Inestable Symfony Version +------------------------------------------------------ + +Instead of creating a new empty project, in this section you'll update an existing +Symfony application to an inestable framework version. Suppose again that Symfony +2.7 version hasn't been released yet and you want to test it in your project. + +First, open the ``composer.json`` file located in the root directory of your +project. Then, edit the value of the version defined for the ``symfony/symfony`` +dependency: + +.. code-block:: json + + { + "require": { + // ... + "symfony/symfony" : "2.7.*" + } + } + +Then, before updating your dependencies, make sure that the project configuration +allows to install inestable versions. If the ``composer.json`` file contains a +``minimum-stability`` option, change its value to ``dev``. If that option doesn't +exist, add it as follows: + +.. code-block:: json + + { + "require": { + // ... + "symfony/symfony" : "2.7.*" + }, + "minimum-stability": "dev" + } + +If you prefer to test a Symfony beta version, replace the ``dev`` value of the +``minimum-stability`` option by ``beta``. + +Then, open a command console, enter your project directory and execute the following command to update your project dependencies: + +.. code-block:: bash + + $ composer update + +.. tip:: + + If you use Git to manage the project's code, it's a good practice to create + a new branch to test the new Symfony version. This solution avoids introducing + any issue in your application and allows you to test the new version with + total confidence: + + .. code-block:: bash + + $ cd projects/my_project/ + $ git checkout -b testing_new_symfony + // update composer.json configuration + $ composer update + + // ... after testing the new Symfony version + $ git checkout master + $ git branch -D testing_new_symfony diff --git a/cookbook/install/upgrading.rst b/cookbook/install/upgrading.rst new file mode 100644 index 00000000000..88a5ecc22a6 --- /dev/null +++ b/cookbook/install/upgrading.rst @@ -0,0 +1,141 @@ +How to Upgrade Your Symfony Project +=================================== + +So a new Symfony release has come out and you want to upgrade, great! Fortunately, +because Symfony protects backwards-compatibility very closely, this *should* +be quite easy. + +There are two types of upgrades, and both are a little different: + +* :ref:`upgrading-patch-version` +* :ref:`upgrading-minor-version` + +.. _upgrading-patch-version: + +Upgrading a Patch Version (e.g. 2.6.0 to 2.6.1) +----------------------------------------------- + +If you're upgrading and only the patch version (the last number) is changing, +then it's *really* easy: + +.. code-block:: bash + + $ composer update symfony/symfony + +That's it! You should not encounter any backwards-compatibility breaks or +need to change anything else in your code. That's because when you started +your project, your ``composer.json`` included Symfony using a constraint +like ``2.6.*``, where only the *last* version number will change when you +update. + +You may also want to upgrade the rest of your libraries. If you've done a +good job with your `version constraints`_ in ``composer.json``, you can do +this safely by running: + +.. code-block:: bash + + $ composer update + +But beware. If you have some bad `version constraints`_ in your ``composer.json``, +(e.g. ``dev-master``), then this could upgrade some non-Symfony libraries +to new versions that contain backwards-compatibility breaking changes. + +.. _upgrading-minor-version: + +Upgrading a Minor Version (e.g. 2.5.3 to 2.6.1) +----------------------------------------------- + +If you're upgrading a minor version (where the middle number changes), then +you should also *not* encounter significant backwards compatibility changes. +For details, see our :doc:`/contributing/code/bc`. + +However, some backwards-compatibility breaks *are* possible, and you'll learn +in a second how to prepare for them. + +There are two steps to upgrading: + +:ref:`upgrade-minor-symfony-composer`; +:ref:`upgrade-minor-symfony-code` + +.. _`upgrade-minor-symfony-composer`: + +1) Update the Symfony Library via Composer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +First, you need to update Symfony by modifying your ``composer.json`` file +to use the new version: + +.. code-block:: json + + { + "...": "...", + + "require": { + "php": ">=5.3.3", + "symfony/symfony": "2.6.*", + "...": "... no changes to anything else..." + }, + "...": "...", + } + +Next, use Composer to download new versions of the libraries: + +.. code-block:: bash + + $ composer update symfony/symfony + +You may also want to upgrade the rest of your libraries. If you've done a +good job with your `version constraints`_ in ``composer.json``, you can do +this safely by running: + +.. code-block:: bash + + $ composer update + +But beware. If you have some bad `version constraints`_ in your ``composer.json``, +(e.g. ``dev-master``), then this could upgrade some non-Symfony libraries +to new versions that contain backwards-compatibility breaking changes. + +.. _`upgrade-minor-symfony-code`: + +2) Updating Your Code to Work with the new Version +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In theory, you should be done! However, you *may* need to make a few changes +to your code to get everything working. Additionally, some features you're +using might still work, but might now be deprecated. That's actually ok, +but if you know about these deprecations, you can start to fix them over +time. + +Every version of Symfony comes with an UPGRADE file that describes these +changes. Below are links to the file for each version, which you'll need +to read to see if you need any code changes. + +.. tip:: + + Don't see the version here that you're upgrading to? Just find the + UPGRADE-X.X.md file for the appropriate version on the `Symfony Repository`_. + +Upgrading to Symfony 2.6 +........................ + +First, of course, update your ``composer.json`` file with the ``2.6`` version +of Symfony as described above in :ref:`upgrade-minor-symfony-composer`. + +Next, check the `UPGRADE-2.6`_ document for details about any code changes +that you might need to make in your project. + +Upgrading to Symfony 2.5 +........................ + +First, of course, update your ``composer.json`` file with the ``2.5`` version +of Symfony as described above in :ref:`upgrade-minor-symfony-composer`. + +Next, check the `UPGRADE-2.5`_ document for details about any code changes +that you might need to make in your project. + +.. _`UPGRADE-2.5`: https://github.com/symfony/symfony/blob/2.5/UPGRADE-2.5.md +.. _`UPGRADE-2.6`: https://github.com/symfony/symfony/blob/2.6/UPGRADE-2.6.md +.. _`Symfony Repository`: https://github.com/symfony/symfony +.. _`Composer Package Versions`: https://getcomposer.org/doc/01-basic-usage.md#package-versions +.. _`version constraints`: https://getcomposer.org/doc/01-basic-usage.md#package-versions diff --git a/cookbook/map.rst.inc b/cookbook/map.rst.inc index 2c4d8eb94f6..c45d0942167 100644 --- a/cookbook/map.rst.inc +++ b/cookbook/map.rst.inc @@ -112,6 +112,11 @@ * :doc:`/cookbook/frontend/bower` +* **Installing and Upgrading** + + * :doc:`/cookbook/upgrading` + * :doc:`/cookbook/inestable_version` + * :doc:`/cookbook/logging/index` * :doc:`/cookbook/logging/monolog` @@ -207,12 +212,15 @@ * (email) :doc:`/cookbook/email/testing` * (form) :doc:`/cookbook/form/unit_testing` +<<<<<<< HEAD * :doc:`/cookbook/upgrade/index` * :doc:`/cookbook/upgrade/patch_version` * :doc:`/cookbook/upgrade/minor_version` * :doc:`/cookbook/upgrade/major_version` +======= +>>>>>>> Added a new articule about using/installing inestable Symfony versions * :doc:`/cookbook/validation/index` * :doc:`/cookbook/validation/custom_constraint` From df22b75dcf9059427dfec84c3bbaa03a3131fb75 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 09:59:26 +0200 Subject: [PATCH 02/15] Fixed typo: "inestable" -> "unstable" --- cookbook/install/inestable_versions | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/cookbook/install/inestable_versions b/cookbook/install/inestable_versions index e9957c1b11f..b93403e4d19 100644 --- a/cookbook/install/inestable_versions +++ b/cookbook/install/inestable_versions @@ -1,5 +1,5 @@ -How to Install and Use an Inestable Symfony Version -=================================================== +How to Install and Use an Unstable Symfony Version +================================================== Symfony releases two new minor versions (2.5, 2.6, 2.7, etc.) per year, one in May and one in November (:doc:`see releases detail `). @@ -9,8 +9,8 @@ to ensure that they will keep working as expected. In this article you'll learn how to install and use new Symfony versions before they are released as stable versions. -Creating a New Project Based on an Inestable Symfony Version ------------------------------------------------------------- +Creating a New Project Based on an Unstable Symfony Version +----------------------------------------------------------- Suppose that Symfony 2.7 version hasn't been released yet and you want to create a new project to test its features. First, :doc:`install Composer ` @@ -32,11 +32,11 @@ option: $ composer create-project symfony/framework-standard-edition my_project "2.7.*" --stability=beta -Upgrading your Project to an Inestable Symfony Version ------------------------------------------------------- +Upgrading your Project to an Unstable Symfony Version +----------------------------------------------------- Instead of creating a new empty project, in this section you'll update an existing -Symfony application to an inestable framework version. Suppose again that Symfony +Symfony application to an unstable framework version. Suppose again that Symfony 2.7 version hasn't been released yet and you want to test it in your project. First, open the ``composer.json`` file located in the root directory of your @@ -53,7 +53,7 @@ dependency: } Then, before updating your dependencies, make sure that the project configuration -allows to install inestable versions. If the ``composer.json`` file contains a +allows to install unstable versions. If the ``composer.json`` file contains a ``minimum-stability`` option, change its value to ``dev``. If that option doesn't exist, add it as follows: From 27229330682deb36bbace6dfb4ea736e500c79ae Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 10:01:36 +0200 Subject: [PATCH 03/15] Fixed articles links --- cookbook/install/index.rst | 1 + .../install/{inestable_versions => unstable_versions} | 0 cookbook/map.rst.inc | 9 +++------ 3 files changed, 4 insertions(+), 6 deletions(-) rename cookbook/install/{inestable_versions => unstable_versions} (100%) diff --git a/cookbook/install/index.rst b/cookbook/install/index.rst index dc0f2c4212f..9177815770e 100644 --- a/cookbook/install/index.rst +++ b/cookbook/install/index.rst @@ -5,3 +5,4 @@ Install and Upgrade :maxdepth: 2 upgrading + unstable_versions diff --git a/cookbook/install/inestable_versions b/cookbook/install/unstable_versions similarity index 100% rename from cookbook/install/inestable_versions rename to cookbook/install/unstable_versions diff --git a/cookbook/map.rst.inc b/cookbook/map.rst.inc index c45d0942167..797e6658e53 100644 --- a/cookbook/map.rst.inc +++ b/cookbook/map.rst.inc @@ -112,10 +112,10 @@ * :doc:`/cookbook/frontend/bower` -* **Installing and Upgrading** +* :doc:`/cookbook/install/index` - * :doc:`/cookbook/upgrading` - * :doc:`/cookbook/inestable_version` + * :doc:`/cookbook/install/upgrading` + * :doc:`/cookbook/install/unstable_version` * :doc:`/cookbook/logging/index` @@ -212,15 +212,12 @@ * (email) :doc:`/cookbook/email/testing` * (form) :doc:`/cookbook/form/unit_testing` -<<<<<<< HEAD * :doc:`/cookbook/upgrade/index` * :doc:`/cookbook/upgrade/patch_version` * :doc:`/cookbook/upgrade/minor_version` * :doc:`/cookbook/upgrade/major_version` -======= ->>>>>>> Added a new articule about using/installing inestable Symfony versions * :doc:`/cookbook/validation/index` * :doc:`/cookbook/validation/custom_constraint` From 719e52c589d0190cbf7bd9b3981457549fef3949 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 17:06:20 +0200 Subject: [PATCH 04/15] Added the missing file extension --- cookbook/install/{unstable_versions => unstable_versions.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename cookbook/install/{unstable_versions => unstable_versions.rst} (100%) diff --git a/cookbook/install/unstable_versions b/cookbook/install/unstable_versions.rst similarity index 100% rename from cookbook/install/unstable_versions rename to cookbook/install/unstable_versions.rst From 6d6303c259f77e08cafad463ddfe9cb35023a9bc Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 17:21:32 +0200 Subject: [PATCH 05/15] Fixed a minor error in some index file --- cookbook/map.rst.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookbook/map.rst.inc b/cookbook/map.rst.inc index 797e6658e53..1faf17e7f84 100644 --- a/cookbook/map.rst.inc +++ b/cookbook/map.rst.inc @@ -115,7 +115,7 @@ * :doc:`/cookbook/install/index` * :doc:`/cookbook/install/upgrading` - * :doc:`/cookbook/install/unstable_version` + * :doc:`/cookbook/install/unstable_versions` * :doc:`/cookbook/logging/index` From 724c17ff1dfaca92f410700675ed78c966b59cea Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 17:40:11 +0200 Subject: [PATCH 06/15] Simplified instructions --- cookbook/install/unstable_versions.rst | 30 +++++++------------------- 1 file changed, 8 insertions(+), 22 deletions(-) diff --git a/cookbook/install/unstable_versions.rst b/cookbook/install/unstable_versions.rst index b93403e4d19..9df8fe95085 100644 --- a/cookbook/install/unstable_versions.rst +++ b/cookbook/install/unstable_versions.rst @@ -41,41 +41,27 @@ Symfony application to an unstable framework version. Suppose again that Symfony First, open the ``composer.json`` file located in the root directory of your project. Then, edit the value of the version defined for the ``symfony/symfony`` -dependency: +dependency as follows: .. code-block:: json { "require": { // ... - "symfony/symfony" : "2.7.*" + "symfony/symfony" : "2.7.*@dev" } } -Then, before updating your dependencies, make sure that the project configuration -allows to install unstable versions. If the ``composer.json`` file contains a -``minimum-stability`` option, change its value to ``dev``. If that option doesn't -exist, add it as follows: - -.. code-block:: json - - { - "require": { - // ... - "symfony/symfony" : "2.7.*" - }, - "minimum-stability": "dev" - } - -If you prefer to test a Symfony beta version, replace the ``dev`` value of the -``minimum-stability`` option by ``beta``. - -Then, open a command console, enter your project directory and execute the following command to update your project dependencies: +Then, open a command console, enter your project directory and execute the following +command to update your project dependencies: .. code-block:: bash $ composer update +If you prefer to test a Symfony beta version, replace the ``"2.7.*@dev"`` constraint +by ``"2.7.*@beta1"`` (or any other beta number). + .. tip:: If you use Git to manage the project's code, it's a good practice to create @@ -87,7 +73,7 @@ Then, open a command console, enter your project directory and execute the follo $ cd projects/my_project/ $ git checkout -b testing_new_symfony - // update composer.json configuration + // ... update composer.json configuration $ composer update // ... after testing the new Symfony version From e1f621e8617fd467e05727dc2b705a2267d4fc72 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 17:42:42 +0200 Subject: [PATCH 07/15] Added a new entry in the redirection_map --- redirection_map | 1 + 1 file changed, 1 insertion(+) diff --git a/redirection_map b/redirection_map index 7e60794f8c6..b0cb87b38ad 100644 --- a/redirection_map +++ b/redirection_map @@ -14,6 +14,7 @@ /cookbook/service_container/parentservices /components/dependency_injection/parentservices /cookbook/service_container/factories /components/dependency_injection/factories /cookbook/service_container/tags /components/dependency_injection/tags +/cookbook/upgrading /cookbook/install/upgrading /reference/configuration/mongodb /bundles/DoctrineMongoDBBundle/config /reference/YAML /components/yaml /components/dependency_injection /components/dependency_injection/introduction From caff8d2b9e379588153020ca7d1dba4f60db4068 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 17:44:41 +0200 Subject: [PATCH 08/15] Minor rewording --- cookbook/install/unstable_versions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookbook/install/unstable_versions.rst b/cookbook/install/unstable_versions.rst index 9df8fe95085..721cb3058ef 100644 --- a/cookbook/install/unstable_versions.rst +++ b/cookbook/install/unstable_versions.rst @@ -4,7 +4,7 @@ How to Install and Use an Unstable Symfony Version Symfony releases two new minor versions (2.5, 2.6, 2.7, etc.) per year, one in May and one in November (:doc:`see releases detail `). Testing the new Symfony versions in your projects as soon as possible is important -to ensure that they will keep working as expected. +to ensure that they will keep working after upgrading to the new version. In this article you'll learn how to install and use new Symfony versions before they are released as stable versions. From a9fee2f7f79d429793eec2e6b58cc3e9a8cb4d84 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 17:45:55 +0200 Subject: [PATCH 09/15] Fixed a link to an internal document --- cookbook/install/unstable_versions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookbook/install/unstable_versions.rst b/cookbook/install/unstable_versions.rst index 721cb3058ef..f13b0089429 100644 --- a/cookbook/install/unstable_versions.rst +++ b/cookbook/install/unstable_versions.rst @@ -2,7 +2,7 @@ How to Install and Use an Unstable Symfony Version ================================================== Symfony releases two new minor versions (2.5, 2.6, 2.7, etc.) per year, one in -May and one in November (:doc:`see releases detail `). +May and one in November (:doc:`see releases detail `). Testing the new Symfony versions in your projects as soon as possible is important to ensure that they will keep working after upgrading to the new version. From bae8043405fd77f300c71286ece15feb46dfc3ce Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 19:45:41 +0200 Subject: [PATCH 10/15] Fixed the beta version constraints --- cookbook/install/unstable_versions.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/cookbook/install/unstable_versions.rst b/cookbook/install/unstable_versions.rst index f13b0089429..196b270aaf8 100644 --- a/cookbook/install/unstable_versions.rst +++ b/cookbook/install/unstable_versions.rst @@ -60,7 +60,8 @@ command to update your project dependencies: $ composer update If you prefer to test a Symfony beta version, replace the ``"2.7.*@dev"`` constraint -by ``"2.7.*@beta1"`` (or any other beta number). +by ``"2.7.0-beta1"`` to install a specific beta number or ``2.7.*@beta`` to get +the most recent beta version. .. tip:: From 038caa5b8697968d0646f1dbda3f646e20dd4262 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 17 Apr 2015 23:24:05 +0200 Subject: [PATCH 11/15] Fixed minor issues --- cookbook/install/unstable_versions.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/cookbook/install/unstable_versions.rst b/cookbook/install/unstable_versions.rst index 196b270aaf8..ba776160fff 100644 --- a/cookbook/install/unstable_versions.rst +++ b/cookbook/install/unstable_versions.rst @@ -6,14 +6,14 @@ May and one in November (:doc:`see releases detail ` +a new project to test its features. First, :doc:`install the Composer ` package manager. Then, open a command console, enter your projects directory and execute the following command: @@ -57,7 +57,7 @@ command to update your project dependencies: .. code-block:: bash - $ composer update + $ composer update symfony/symfony If you prefer to test a Symfony beta version, replace the ``"2.7.*@dev"`` constraint by ``"2.7.0-beta1"`` to install a specific beta number or ``2.7.*@beta`` to get @@ -74,9 +74,9 @@ the most recent beta version. $ cd projects/my_project/ $ git checkout -b testing_new_symfony - // ... update composer.json configuration + # ... update composer.json configuration $ composer update - // ... after testing the new Symfony version + # ... after testing the new Symfony version $ git checkout master $ git branch -D testing_new_symfony From d5f3d82dba999e1f5349335873830fb19c1940c1 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Sun, 19 Apr 2015 13:44:05 +0200 Subject: [PATCH 12/15] Minor improvement in a command --- cookbook/install/unstable_versions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookbook/install/unstable_versions.rst b/cookbook/install/unstable_versions.rst index ba776160fff..1b368e453c1 100644 --- a/cookbook/install/unstable_versions.rst +++ b/cookbook/install/unstable_versions.rst @@ -75,7 +75,7 @@ the most recent beta version. $ cd projects/my_project/ $ git checkout -b testing_new_symfony # ... update composer.json configuration - $ composer update + $ composer update symfony/symfony # ... after testing the new Symfony version $ git checkout master From 224c3802ee9c0ae5934b84447f98ad2707aad55e Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Sat, 23 May 2015 21:03:44 +0200 Subject: [PATCH 13/15] Fixed a lot of issues pointed by Ryan --- cookbook/install/unstable_versions.rst | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/cookbook/install/unstable_versions.rst b/cookbook/install/unstable_versions.rst index 1b368e453c1..ec8219652e0 100644 --- a/cookbook/install/unstable_versions.rst +++ b/cookbook/install/unstable_versions.rst @@ -1,10 +1,5 @@ -How to Install and Use an Unstable Symfony Version -================================================== - -Symfony releases two new minor versions (2.5, 2.6, 2.7, etc.) per year, one in -May and one in November (:doc:`see releases detail `). -Testing the new Symfony versions in your projects as soon as possible is important -to ensure that they will keep working after upgrading to the new version. +How to Install or Upgrade to the Latest, Unreleased Symfony Version +=================================================================== In this article, you'll learn how to install and use new Symfony versions before they are released as stable versions. @@ -14,7 +9,7 @@ Creating a New Project Based on an Unstable Symfony Version Suppose that Symfony 2.7 version hasn't been released yet and you want to create a new project to test its features. First, :doc:`install the Composer ` -package manager. Then, open a command console, enter your projects directory and +package manager. Then, open a command console, enter your project's directory and execute the following command: .. code-block:: bash @@ -35,9 +30,8 @@ option: Upgrading your Project to an Unstable Symfony Version ----------------------------------------------------- -Instead of creating a new empty project, in this section you'll update an existing -Symfony application to an unstable framework version. Suppose again that Symfony -2.7 version hasn't been released yet and you want to test it in your project. +Suppose again that Symfony 2.7 hasn't been released yet and you want to upgrade +an existing application to test that your project works with it. First, open the ``composer.json`` file located in the root directory of your project. Then, edit the value of the version defined for the ``symfony/symfony`` @@ -52,8 +46,8 @@ dependency as follows: } } -Then, open a command console, enter your project directory and execute the following -command to update your project dependencies: +Finally, open a command console, enter your project directory and execute the +following command to update your project dependencies: .. code-block:: bash From 1378ec9762a46f41b8e75b240259434dd44e4d98 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Sat, 23 May 2015 21:38:10 +0200 Subject: [PATCH 14/15] Added a note about the Symfony Upgrading Guide --- cookbook/install/unstable_versions.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cookbook/install/unstable_versions.rst b/cookbook/install/unstable_versions.rst index ec8219652e0..b1d2b9abc77 100644 --- a/cookbook/install/unstable_versions.rst +++ b/cookbook/install/unstable_versions.rst @@ -57,6 +57,10 @@ If you prefer to test a Symfony beta version, replace the ``"2.7.*@dev"`` constr by ``"2.7.0-beta1"`` to install a specific beta number or ``2.7.*@beta`` to get the most recent beta version. +After upgrading the Symfony version, read the :doc:`Symfony Upgrading Guide ` +to learn how you should proceed to update your application's code in case the new +Symfony version has deprecated some of its features. + .. tip:: If you use Git to manage the project's code, it's a good practice to create From 8e8fad26bf71f4cfd6c46261a2ed22ce43d454f8 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 23 Jun 2015 17:51:29 +0200 Subject: [PATCH 15/15] Removed some wrong labels --- cookbook/install/upgrading.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/cookbook/install/upgrading.rst b/cookbook/install/upgrading.rst index 88a5ecc22a6..34d11369ce5 100644 --- a/cookbook/install/upgrading.rst +++ b/cookbook/install/upgrading.rst @@ -57,8 +57,6 @@ There are two steps to upgrading: :ref:`upgrade-minor-symfony-composer`; :ref:`upgrade-minor-symfony-code` -.. _`upgrade-minor-symfony-composer`: - 1) Update the Symfony Library via Composer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -96,8 +94,6 @@ But beware. If you have some bad `version constraints`_ in your ``composer.json` (e.g. ``dev-master``), then this could upgrade some non-Symfony libraries to new versions that contain backwards-compatibility breaking changes. -.. _`upgrade-minor-symfony-code`: - 2) Updating Your Code to Work with the new Version ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~