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

Can't find any documentation on how to upgrade CakePHP generally #4105

Closed
PoeticIntensity opened this issue Jun 24, 2016 · 8 comments
Closed
Milestone

Comments

@PoeticIntensity
Copy link

Migration guides for specific versions are a great help, but it would be awesome if there was a page that describe best practices on how to upgrade between cake versions generally. Both from git / svn / non-versioned code / etc...

savant told me to open this issue in IRC. If the page already exists, it's on him. :)

@ravage84 ravage84 added this to the 3.x milestone Jun 24, 2016
@ravage84
Copy link
Member

@PoeticIntensity could you broadly outline what content you would expect from such a guide?

Some bullet point list would be a good start.

sarcasmOn
Do you expect this guide to tell you to do a backup of your stuff before?
sarcasmOff

@dereuromark
Copy link
Member

dereuromark commented Jun 24, 2016

There are tons of blog post and resources around it. Not sure that and a lot of other things are suited for cakephp docs, as they usually go out of scope of the actual documentation and would create a thousand pages "bible" of pages that will be harder to read through.
Google for the keywords and you will find the "That's how I did it" kind of articles.

@josegonzalez
Copy link
Member

I'm 👍 on getting some documentation on upgrading between minor versions. The CakePHP core team knows how to upgrade their apps - seems simple enough - but we can definitely provide a good workflow for more junior developers.

For instance, I've seen people ask if they should just start with a fresh app repo and move their src dir over, etc. Providing guidance here would be great to get rid of any ambiguities.

Aside: I normally find what I need on google and wasn't able to find an upgrade guide for Cake3 versions.

Here is what I normally do (and can probably be made into a small section on the migration page):

git checkout -b cakephp-VERSION
composer require cakephp/cakephp:VERSION
# resolve any composer issues
# read the migration guide, remove deprecated code
# use new features where necessary
# add any changes that seem to apply
# look at cakephp/app repo, see if anything yummy in the defaults is now there and copy it over as necessary
phpunit
# resolve test issues
git add . && git commit -m "Upgrade to cakephp VERSION"
git checkout master
git merge cakephp-VERSION

@markstory
Copy link
Member

I think including a short section on how to upgrade between patch and minor versions is probably useful.

@ravage84
Copy link
Member

I think CakeFest is a good time to re-discuss this. Conference attendees might be interested to participate as some might need to upgrade yet.

markstory added a commit that referenced this issue Jun 10, 2017
@markstory
Copy link
Member

I've added upgrade notes to the 3.5 migration guide. Would it make sense to have minor or patch version upgrade instructions in the installation docs?

@jeremyharris
Copy link
Member

Does require update dependencies the same way update --update-with-dependencies does? In some cases depending on requirements, I've seen an update command fail without explicitly telling it to update the deps, such as bake, migrations, etc.

@markstory
Copy link
Member

The way I have it now composer won't update dependencies. We should probably tell people to use --update-with-dependencies as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants