Skip to content
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.

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

Adding a guide about upgrading #4611

Closed
wants to merge 6 commits into from
Closed

Adding a guide about upgrading #4611

wants to merge 6 commits into from

Conversation

weaverryan
Copy link
Member

Q A
Doc fix? no
New docs? yes
Applies to 2.6+
Fixed tickets #4172

Hi guys!

First, the plan is to merge this into 2.6, then backport it to 2.3 (just remove the 2.5 and 2.6 sections about upgrading).

I put this together fairly quickly, and I would really like comments. I've been in front of the computer for awhile, so I'm not convinced this is quite as smooth yet as I'd like it to be!

Overall, I want to fix the issue of "How to I upgrade". We'll say - just go to this page, and it'll walk you through the steps, and even reassure you that you don't need to make any changes to your code (or, you only need to make these very specific changes).

Thanks!


$ composer update symfony/symfony

That's it! You should not encounter any backwards-compatability breaks or
Copy link
Member

Choose a reason for hiding this comment

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

typo: compatability --> compatibility

@wouterj
Copy link
Member

wouterj commented Dec 8, 2014

I'm missing something about checking changes in the SE and updating your edition accordingly.

* If you're using PdoSessionStorage, there was a change in the session schema
that **requires** your session table to be updated. See :doc:`/cookbook/configuration/pdo_session_storage`.

* Symfony 2.6 comes with a great new `dump`_ function. To use it, you'll
Copy link
Member

Choose a reason for hiding this comment

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

there is no link for dump

@stof
Copy link
Member

stof commented Dec 8, 2014

First, the plan is to merge this into 2.6, then backport it to 2.3 (just remove the 2.5 and 2.6 sections about upgrading).

From the git history PoV, merging first into 2.3 would be more logical, given that 2.3 gets merged into other branches

@stof
Copy link
Member

stof commented Dec 8, 2014

Changes introduced in Symfony 2.4 should also appear here, because people upgrading from Symfony 2.3 are also concerned with them, not only with the 2.4 to 2.5 changes

@weaverryan
Copy link
Member Author

@stof I agree, but I had a practical problem. If I'm describing a 2.6 feature, I'd like to link to it, which is only possible on the 2.6 branch. But honestly, we should then just use external links for these few cases, and merge this into 2.3 as you said


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-compability changes.
Copy link
Member

Choose a reason for hiding this comment

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

I think you wanted to say that they contain BC breaking changes, didn't you?

Copy link
Member Author

Choose a reason for hiding this comment

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

👍

@stof
Copy link
Member

stof commented Dec 16, 2014

I agree, but I had a practical problem. If I'm describing a 2.6 feature, I'd like to link to it, which is only possible on the 2.6 branch. But honestly, we should then just use external links for these few cases, and merge this into 2.3 as you said

What I mean is that it would be better for the Git history PoV to work on the 2.3 branch first, and then add the 2.5 and 2.6 sections later (after merging 2.3 into newer branches) rather than working in 2.6 and the backporting to 2.3 removing some sections (and then reverting the removal after merging 2.3 into 2.6).
There is no need to describe a 2.6 feature in the 2.3 branch.

@weaverryan
Copy link
Member Author

Hi guys! I've taken pretty much all of your advice - thank you :). And I've now merged this in. I did remove the specifics about what to look for while upgrading each version - you're right about this - I want to eliminate duplication, and this would have been exactly that. I still list the 2.5 and 2.6 versions, with simple links to their UPGRADE-* files just for convenience so that you have everything you need while reading this. I'm patching this into the 2.3 branch, but I think we should just leave the 2.5 and 2.6 sections in their. Afterall, if I'm using 2.3 and reading the 2.3 docs, it kind of makes sense to see docs on how to upgrade to 2.5 or 2.6. So for this document, I think it makes sense to more or less have just "one" version. If you see any remaining issues, let me know - I think we were at least 98% there, so I wanted to merge this in and move forward. Thanks!

weaverryan added a commit that referenced this pull request Jan 3, 2015
weaverryan added a commit that referenced this pull request Jan 3, 2015
weaverryan added a commit that referenced this pull request Jan 3, 2015
This PR was submitted for the 2.6 branch but it was merged into the 2.3 branch instead (closes #4611).

Discussion
----------

Adding a guide about upgrading

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | 2.6+
| Fixed tickets | #4172

Hi guys!

First, the plan is to merge this into 2.6, then backport it to 2.3 (just remove the 2.5 and 2.6 sections about upgrading).

I put this together fairly quickly, and I would really like comments. I've been in front of the computer for awhile, so I'm not convinced this is quite as smooth yet as I'd like it to be!

Overall, I want to fix the issue of "How to I upgrade". We'll say - just go to this page, and it'll walk you through the steps, and even reassure you that you don't need to make any changes to your code (or, you only need to make these very specific changes).

Thanks!

Commits
-------

9701e46 Adding missing index/map documents
ca1e7df [#4611] A few more tweaks and fixes
e6b3f13 Basically copying a section about upgrading other libraries down into the minor version section
8195a66 [#4611] Removing a few entries I meant to remove before
92b4310 [#4611] Making many tweaks thanks to guys like Javier, Wouter, Christian (xabbuh) and Stof
f86b9c9 Adding a guide about upgrading
@weaverryan weaverryan closed this Jan 3, 2015
weaverryan added a commit that referenced this pull request Jan 3, 2015
* 2.3: (33 commits)
  Fixing bad reference
  [#4743] parts -> part - subjective, but this sounds slightly better to me
  Update web_server_configuration.rst
  Update web_server_configuration.rst
  Update web_server_configuration.rst
  Add exception to console exception log
  [#4454] Re-wording section, but it may not actually be accurate
  More concrete explanation of validation groups
  Adding missing index/map documents
  [#4611] A few more tweaks and fixes
  Basically copying a section about upgrading other libraries down into the minor version section
  [#4611] Removing a few entries I meant to remove before
  [#4611] Making many tweaks thanks to guys like Javier, Wouter, Christian (xabbuh) and Stof
  Adding a guide about upgrading
  Fix typo and remove redundant sentence
  [Reference] Add default_locale config description
  Clarify tip for creating a new AppBundle
  Update forms.rst
  Rewroded some contents and fixed some lists of elements
  MAde some tweaks suggested by Wouter
  ...

Conflicts:
	book/http_cache.rst
weaverryan added a commit that referenced this pull request Jan 3, 2015
* 2.5: (35 commits)
  Fixing bad reference
  [#4743] parts -> part - subjective, but this sounds slightly better to me
  Update web_server_configuration.rst
  Update web_server_configuration.rst
  Update web_server_configuration.rst
  Add exception to console exception log
  [#4454] Re-wording section, but it may not actually be accurate
  More concrete explanation of validation groups
  Adding missing index/map documents
  [#4611] A few more tweaks and fixes
  Basically copying a section about upgrading other libraries down into the minor version section
  [#4611] Removing a few entries I meant to remove before
  [#4611] Making many tweaks thanks to guys like Javier, Wouter, Christian (xabbuh) and Stof
  Adding a guide about upgrading
  Fix typo and remove redundant sentence
  document the `2.5` validation options
  [Reference] Add default_locale config description
  Clarify tip for creating a new AppBundle
  Update forms.rst
  Rewroded some contents and fixed some lists of elements
  ...

Conflicts:
	book/security.rst
weaverryan added a commit that referenced this pull request Jan 3, 2015
* 2.7: (36 commits)
  Fixing bad reference
  [#4743] parts -> part - subjective, but this sounds slightly better to me
  Update web_server_configuration.rst
  Update web_server_configuration.rst
  Update web_server_configuration.rst
  Add exception to console exception log
  [#4454] Re-wording section, but it may not actually be accurate
  More concrete explanation of validation groups
  Adding missing index/map documents
  [#4611] A few more tweaks and fixes
  Basically copying a section about upgrading other libraries down into the minor version section
  [#4611] Removing a few entries I meant to remove before
  [#4611] Making many tweaks thanks to guys like Javier, Wouter, Christian (xabbuh) and Stof
  Adding a guide about upgrading
  Fix typo and remove redundant sentence
  Formatting fix
  document the `2.5` validation options
  [Reference] Add default_locale config description
  Clarify tip for creating a new AppBundle
  Update forms.rst
  ...
@xabbuh xabbuh deleted the upgrading-guide branch January 4, 2015 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants