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

[WIP] Added an article to explain how to upgrade third-party bundles to Symfony 3 #5894

Merged
merged 6 commits into from
Mar 6, 2016

Conversation

javiereguiluz
Copy link
Member

Q A
Doc fix? no
New docs? yes
Applies to all
Fixed tickets #5879

I've just drafted the skeleton of the article to have something to discuss about the contents.

@javiereguiluz
Copy link
Member Author

The first draft of the article contents is completed. Please review and I'll fix your corrections right away. Thanks!

@wouterj
Copy link
Member

wouterj commented Nov 20, 2015

Hmm, I started bootstrapping such an article as well (for some reason, I completely missed your PR this week...). Just for your info: https://gist.githubusercontent.com/WouterJ/dcb43f67701639f8cd4c/raw/fe9a29eba9aed42d7f7d1df762695b520a8bf3c1/symfony3.rst

I think we have to add some practical guides on how to support both 2.3 and 3.0 for the most commonly used deprecated features. This will work as an example that can be applied for other deprecated features.

These constraints prevent the bundle from using Symfony 3 components, so it makes
it impossible to install it in a Symfony 3 based application. This issue is very
easy to solve thanks to the flexibility of Composer dependencies constraints.
Just replace ``~2.N`` by ``~2.N|~3.0`` (or ``^2.N`` by ``^2.N|~3.0``).
Copy link
Member

Choose a reason for hiding this comment

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

Another commonly used version constraint is >=2.3 (pretty bad, but I've seen quite a few bundles using it). Maybe we have to add a note/tip/caution to avoid using constraints like that and explicitely support only 2 and 3.

@javiereguiluz
Copy link
Member Author

@wouterj thanks for your review and for bootstraping this article yourself too. In cb31c16 I've added a new section copied from your original article, but there is still a lot of work to do.

@weaverryan
Copy link
Member

@javiereguiluz what do you think about writing a post for Symfony.com encouraging bundle authors to start upgrading to 3.0 and telling them they can use this WIP pull request as a reference. We could also link to Wouter's document so that author's have example bundles and pull requests that were used for other bundles.

@wouterj
Copy link
Member

wouterj commented Feb 6, 2016

So, we didn't complete this one before the Symfony 3 release. What do we think about this now, still worth merging?

@xabbuh
Copy link
Member

xabbuh commented Feb 7, 2016

Probably yes as people will have the same questions with Symfony 4 again (of which we already know when it will be published).

@xabbuh
Copy link
Member

xabbuh commented Feb 7, 2016

So I think we should just make this article a bit more generic to not have to change it again with every new major release.

@lushc
Copy link

lushc commented Feb 8, 2016

+1 for getting merged; we're still coming across incompatible bundles, so the docs will be useful in supporting PRs to fix them.

@TomasVotruba
Copy link

@wouterj I'd merge this ASAP, I come to many bundles (even famous) with missing Symfony 3 support.
Having some guidelines how to do that might speed up this process significantly.

@weaverryan weaverryan merged commit cb31c16 into symfony:2.3 Mar 6, 2016
weaverryan added a commit that referenced this pull request Mar 6, 2016
…party bundles to Symfony 3 (javiereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

[WIP] Added an article to explain how to upgrade third-party bundles to Symfony 3

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | all
| Fixed tickets | #5879

I've just drafted the skeleton of the article to have something to discuss about the contents.

Commits
-------

cb31c16 Added a new section of tips and tricks to upgrade bundles to Symfony 3.0
3697d81 Fixed a lot of issues reported by Wouter
1e2ccd1 Completed the section "Test your Bundle in Symfony 3"
4b13fab Completed the section "Look for Deprecations and Fix Them"
0e585b4 Completed "Allow to Install Symfony 3 Components" section
4e93eb5 Added an article to explain how to upgrade third-party bundles to Symfony 3
@weaverryan
Copy link
Member

Indeed - this got lost and we didn't merge! I've merged it and removed the todo sections. I think it's definitely a worthwhile guide - especially the travis-ci setup. Before 4.0, we should work on updating bundles and update this guide with the common things we find (so it can be a proactive guide).

Thanks @javiereguiluz!

@TomasVotruba
Copy link

Thank you @javiereguiluz and @weaverryan

weaverryan added a commit that referenced this pull request Mar 6, 2016
* 2.3:
  Update tools.rst
  [#5894] Minor tweaks and removing the todo sections for now
  Added a new section of tips and tricks to upgrade bundles to Symfony 3.0
  Fixed a lot of issues reported by Wouter
  Completed the section "Test your Bundle in Symfony 3"
  Completed the section "Look for Deprecations and Fix Them"
  Completed "Allow to Install Symfony 3 Components" section
  Added an article to explain how to upgrade third-party bundles to Symfony 3
weaverryan added a commit that referenced this pull request Mar 6, 2016
* 2.7:
  Update tools.rst
  [#6282] Removing PropertyPath as type and clarifying last sentence
  [#5894] Minor tweaks and removing the todo sections for now
  [Form] fix `choice_label` values
  Added a new section of tips and tricks to upgrade bundles to Symfony 3.0
  Fixed a lot of issues reported by Wouter
  Completed the section "Test your Bundle in Symfony 3"
  Completed the section "Look for Deprecations and Fix Them"
  Completed "Allow to Install Symfony 3 Components" section
  Added an article to explain how to upgrade third-party bundles to Symfony 3
weaverryan added a commit that referenced this pull request Mar 6, 2016
* 2.8:
  Update tools.rst
  [#6282] Removing PropertyPath as type and clarifying last sentence
  [#5894] Minor tweaks and removing the todo sections for now
  [Form] fix `choice_label` values
  Added a new section of tips and tricks to upgrade bundles to Symfony 3.0
  Fixed a lot of issues reported by Wouter
  Completed the section "Test your Bundle in Symfony 3"
  Completed the section "Look for Deprecations and Fix Them"
  Completed "Allow to Install Symfony 3 Components" section
  Added an article to explain how to upgrade third-party bundles to Symfony 3
weaverryan added a commit that referenced this pull request Mar 6, 2016
* 3.0:
  Update tools.rst
  [#6282] Removing PropertyPath as type and clarifying last sentence
  [#5894] Minor tweaks and removing the todo sections for now
  [Form] fix `choice_label` values
  Added a new section of tips and tricks to upgrade bundles to Symfony 3.0
  Fixed a lot of issues reported by Wouter
  Completed the section "Test your Bundle in Symfony 3"
  Completed the section "Look for Deprecations and Fix Them"
  Completed "Allow to Install Symfony 3 Components" section
  Added an article to explain how to upgrade third-party bundles to Symfony 3
@javiereguiluz javiereguiluz deleted the fix_5879 branch May 24, 2018 16:00
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.

None yet

6 participants