Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 70cb418

Browse files
committed
Merge branch '2.2' into 2.3
Conflicts: contributing/documentation/overview.rst
2 parents b6c4eac + c1e4754 commit 70cb418

File tree

2 files changed

+65
-15
lines changed

2 files changed

+65
-15
lines changed

contributing/community/releases.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ release comes out every *six months*: one in *May* and one in *November*.
1313
"rules" explained in this document must be strictly followed as of Symfony
1414
2.4.
1515

16+
.. _contributing-release-development:
17+
1618
Development
1719
-----------
1820

@@ -29,6 +31,8 @@ During the development phase, any new feature can be reverted if it won't be
2931
finished in time or if it won't be stable enough to be included in the current
3032
final release.
3133

34+
.. _contributing-release-maintenance:
35+
3236
Maintenance
3337
-----------
3438

contributing/documentation/overview.rst

Lines changed: 61 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ Consistent with Symfony's source code, the documentation repository is split int
2929
multiple branches, corresponding to the different versions of Symfony itself.
3030
The ``master`` branch holds the documentation for the development branch of the code.
3131

32-
Unless you're documenting a feature that was introduced *after* Symfony 2.1
33-
(e.g. in Symfony 2.2), your changes should always be based on the 2.1 branch.
34-
To do this checkout the 2.1 branch before the next step:
32+
Unless you're documenting a feature that was introduced *after* Symfony 2.2
33+
(e.g. in Symfony 2.3), your changes should always be based on the 2.2 branch.
34+
To do this checkout the 2.2 branch before the next step:
3535

3636
.. code-block:: bash
3737
38-
$ git checkout 2.1
38+
$ git checkout 2.2
3939
4040
.. tip::
4141

42-
Your base branch (e.g. 2.1) will become the "Applies to" in the :ref:`doc-contributing-pr-format`
42+
Your base branch (e.g. 2.2) will become the "Applies to" in the :ref:`doc-contributing-pr-format`
4343
that you'll use later.
4444

4545
Next, create a dedicated branch for your changes (for organization):
@@ -60,16 +60,16 @@ Following the example, the pull request will default to be between your
6060
.. image:: /images/docs-pull-request.png
6161
:align: center
6262

63-
If you have made your changes based on the 2.1 branch then you need to change
64-
the base branch to be 2.1 on the preview page:
63+
If you have made your changes based on the 2.2 branch then you need to change
64+
the base branch to be 2.2 on the preview page:
6565

6666
.. image:: /images/docs-pull-request-change-base.png
6767
:align: center
6868

6969
.. note::
7070

71-
All changes made to a branch (e.g. 2.1) will be merged up to each "newer"
72-
branch (e.g. 2.2, master, etc) for the next release on a weekly basis.
71+
All changes made to a branch (e.g. 2.2) will be merged up to each "newer"
72+
branch (e.g. 2.3, master, etc) for the next release on a weekly basis.
7373

7474
GitHub covers the topic of `pull requests`_ in detail.
7575

@@ -116,7 +116,7 @@ An example submission could now look as follows:
116116
| ------------- | ---
117117
| Doc fix? | yes
118118
| New docs? | yes (symfony/symfony#2500)
119-
| Applies to | all (or 2.1+)
119+
| Applies to | all (or 2.3+)
120120
| Fixed tickets | #1075
121121
122122
.. tip::
@@ -136,8 +136,8 @@ tag and a short description:
136136

137137
.. code-block:: text
138138
139-
.. versionadded:: 2.2
140-
The ``askHiddenResponse`` method was added in Symfony 2.2.
139+
.. versionadded:: 2.3
140+
The ``askHiddenResponse`` method was added in Symfony 2.3.
141141
142142
You can also ask a question and hide the response. This is particularly...
143143
@@ -146,11 +146,11 @@ how the behavior has changed.
146146

147147
.. code-block:: text
148148
149-
.. versionadded:: 2.2
149+
.. versionadded:: 2.3
150150
The ``include()`` function is a new Twig feature that's available in
151-
Symfony 2.2. Prior, the ``{% include %}`` tag was used.
151+
Symfony 2.3. Prior, the ``{% include %}`` tag was used.
152152
153-
Whenever a new minor version of Symfony2 is released (e.g. 2.3, 2.4, etc),
153+
Whenever a new minor version of Symfony2 is released (e.g. 2.4, 2.5, etc),
154154
a new branch of the documentation is created from the ``master`` branch.
155155
At this point, all the ``versionadded`` tags for Symfony2 versions that have
156156
reached end-of-life will be removed. For example, if Symfony 2.5 were released
@@ -183,3 +183,49 @@ Read the dedicated :doc:`document <translations>`.
183183
.. _`fork`: https://help.github.com/articles/fork-a-repo
184184
.. _`pull requests`: https://help.github.com/articles/using-pull-requests
185185
.. _`Documentation Build Errors`: http://symfony.com/doc/build_errors
186+
187+
Managing Releases
188+
-----------------
189+
190+
Symfony has a very standardized release process, which you can read more
191+
about in the :doc:`/contributing/community/releases` section.
192+
193+
To keep up with the release process, the documentation team makes several
194+
changes to the documentation at various parts of the lifecycle.
195+
196+
When a Release reaches "end of maintenance"
197+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198+
199+
Every release will eventually reach its "end of maintenance". For details,
200+
see :ref:`contributing-release-maintenance`.
201+
202+
When a release reaches its end of maintenance, the following items are done.
203+
For this example, suppose version 2.1 has just reached its end of maintenance:
204+
205+
* Changes and pull requests are no longer merged into to the branch (2.1),
206+
except for security updates, which are merged until the release reaches
207+
its "end of life".
208+
209+
* All branches still under maintenance (e.g. 2.2 and higher) are updated
210+
to reflect that pull requests should start from the now-oldest maintained
211+
version (e.g. 2.2).
212+
213+
* Remove all ``versionadded`` directives - and any other notes related to features
214+
changing or being new - for the version (e.g. 2.1) from the master branch.
215+
The result is that the next release (which is the first that comes entirely
216+
*after* the end of maintenance of this branch), will have no mentions of
217+
the old version (e.g. 2.1).
218+
219+
When a new Branch is created for a Release
220+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221+
222+
During the :ref:`stabilization phase<contributing-release-development>`, a
223+
new branch on the documentation is created. For example, if version 2.3 were
224+
being stabilized, then a new 2.3 branch would be created for it. When this
225+
happens, the following items are done:
226+
227+
* Change all version and master references to the correct version (e.g. 2.3).
228+
For example, in installation chapters, we reference the version you should
229+
use for installation. As an example, see the changes made in `PR #2688`_.
230+
231+
.. _`PR #2688`: https://github.com/symfony/symfony-docs/pull/2688

0 commit comments

Comments
 (0)