godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

Document upgrading a project between Godot versions

Open Calinou opened this issue 4 years ago • 2 comments

We should have a documentation page about upgrading from a Godot version to another (e.g. 2.x to 3.2, 3.2 to 4.0). It should document all breaking changes, what to do and give a rough estimate of the time required/complexity of each task.

See the Laravel upgrade guide for an example of such a page.

Suggested table of contents

  • Foreword: Should I upgrade my Godot version?
    • Mention example cases where this is a good idea, and other cases where this is a bad idea.
  • Link to the Godot release policy page
  • Subpage about upgrading from 2.x to 3.2
  • Subpage about upgrading from 3.2 to 4.0

Calinou avatar Mar 11 '21 19:03 Calinou

I'm not sure if there's a reason to make a 2.x to 3.2 guide now. I feel like anyone who was going to upgrade their project would have done so already.

skyace65 avatar Mar 15 '21 00:03 skyace65

In the meantime we got https://docs.godotengine.org/en/latest/tutorials/migrating/upgrading_to_godot_4.html to upgrade from Godot 3 to 4. And since modern projects must have already upgraded to v3 as noted in last comment, that's basically the gist of it.

Should we close this issue as we consider the job done, or recycle it to track what's left to do on said page?

hsandt avatar Feb 26 '23 13:02 hsandt

Closing per @hsandt's comment.

Calinou avatar Jul 04 '23 15:07 Calinou