Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a97bbc8

Browse filesBrowse files
committed
Merge branch '5.1' into master
* 5.1: Doc link script rollback option Add an explain section to update symfony recipes
2 parents 0ec7295 + 9efe791 commit a97bbc8
Copy full SHA for a97bbc8

File tree

4 files changed

+45
-39
lines changed
Filter options

4 files changed

+45
-39
lines changed

‎contributing/code/pull_requests.rst

Copy file name to clipboardExpand all lines: contributing/code/pull_requests.rst
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,8 @@ want to debug are installed by running ``composer install`` inside it.
196196
If symlinks to your local Symfony fork cannot be resolved inside your project due to
197197
your dev environment (for instance when using Vagrant where only the current project
198198
directory is mounted), you can alternatively use the ``--copy`` option.
199+
When finishing testing your Symfony code into your project, you can use
200+
the ``--rollback`` option to make your project back to its original dependencies.
199201

200202
.. _work-on-your-patch:
201203

‎setup/_update_recipes.rst.inc

Copy file name to clipboard
+38Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
3) Updating Recipes
2+
-------------------
3+
4+
Over time - and especially when you upgrade to a new version of a library - an
5+
updated version of the :ref:`recipe <recipes-description>` may be available.
6+
These updates are usually minor - e.g. new comments in a configuration file - but
7+
it's a good idea to keep your files in sync with the recipes.
8+
9+
Symfony Flex provides several commands to help upgrade your recipes. Be sure to
10+
commit any unrelated changes you're working on before starting:
11+
12+
.. versionadded:: 1.6
13+
14+
The recipes commands were introduced in Symfony Flex 1.6.
15+
16+
.. code-block:: terminal
17+
18+
# see a list of all installed recipes and which have updates available
19+
$ composer recipes
20+
21+
# see detailed information about a specific recipes
22+
$ composer recipes symfony/framework-bundle
23+
24+
# update a specific recipes
25+
$ composer recipes:install symfony/framework-bundle --force -v
26+
27+
The tricky part of this process is that the recipe "update" does not perform
28+
any intelligent "upgrading" of your code. Instead, **the updates process re-installs
29+
the latest version of the recipe** which means that **your custom code will be
30+
overridden completely**. After updating a recipe, you need to carefully choose
31+
which changes you want, and undo the rest.
32+
33+
.. admonition:: Screencast
34+
:class: screencast
35+
36+
For a detailed example, see the `SymfonyCasts Symfony 5 Upgrade Tutorial`_.
37+
38+
.. _`SymfonyCasts Symfony 5 Upgrade Tutorial`: https://symfonycasts.com/screencast/symfony5-upgrade

‎setup/upgrade_major.rst

Copy file name to clipboardExpand all lines: setup/upgrade_major.rst
+4-2Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Now, you can start fixing the notices:
8484
OK (10 tests, 20 assertions)
8585
8686
Remaining deprecation notices (6)
87-
87+
8888
The "request" service is deprecated and will be removed in 3.0. Add a type-hint for
8989
Symfony\Component\HttpFoundation\Request to your controller parameters to retrieve the
9090
request instead: 6x
@@ -178,7 +178,9 @@ Next, use Composer to download new versions of the libraries:
178178

179179
.. _upgrade-major-symfony-after:
180180

181-
3) Update your Code to Work with the New Version
181+
.. include:: /setup/_update_recipes.rst.inc
182+
183+
4) Update your Code to Work with the New Version
182184
------------------------------------------------
183185

184186
In some rare situations, the next major version *may* contain backwards-compatibility

‎setup/upgrade_minor.rst

Copy file name to clipboardExpand all lines: setup/upgrade_minor.rst
+1-37Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -91,43 +91,7 @@ These documents can also be found in the `Symfony Repository`_.
9191

9292
.. _updating-flex-recipes:
9393

94-
3) Updating Recipes
95-
-------------------
96-
97-
Over time - and especially when you upgrade to a new version of a library - an
98-
updated version of the :ref:`recipe <recipes-description>` may be available.
99-
These updates are usually minor - e.g. new comments in a configuration file - but
100-
it's a good idea to update the core Symfony recipes.
101-
102-
Symfony Flex provides several commands to help upgrade your recipes. Be sure to
103-
commit any unrelated changes you're working on before starting:
104-
105-
.. versionadded:: 1.6
106-
107-
The recipes commands were introduced in Symfony Flex 1.6.
108-
109-
.. code-block:: terminal
110-
111-
# see a list of all installed recipes and which have updates available
112-
$ composer recipes
113-
114-
# see detailed information about a specific recipes
115-
$ composer recipes symfony/framework-bundle
116-
117-
# update a specific recipes
118-
$ composer recipes:install symfony/framework-bundle --force -v
119-
120-
The tricky part of this process is that the recipe "update" does not perform
121-
any intelligent "upgrading" of your code. Instead, **the updates process re-installs
122-
the latest version of the recipe** which means that **your custom code will be
123-
overridden completely**. After updating a recipe, you need to carefully choose
124-
which changes you want, and undo the rest.
125-
126-
.. admonition:: Screencast
127-
:class: screencast
128-
129-
For a detailed example, see the `SymfonyCasts Symfony 5 Upgrade Tutorial`_.
94+
.. include:: /setup/_update_recipes.rst.inc
13095

13196
.. _`Symfony Repository`: https://github.com/symfony/symfony
13297
.. _`UPGRADE-4.4.md`: https://github.com/symfony/symfony/blob/4.4/UPGRADE-4.4.md
133-
.. _`SymfonyCasts Symfony 5 Upgrade Tutorial`: https://symfonycasts.com/screencast/symfony5-upgrade

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.