Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#28349 closed Cleanup/optimization (fixed)

Document the recommended way to upgrade Django from LTS to LTS

Reported by: eduvik Owned by: Emmanuel
Component: Documentation Version: 1.11
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

If I want to upgrade from the previous LTS (1.8) to the current (1.11) (presumably a common upgrade path) and go to the release notes/incompatible changes for 1.11 (https://docs.djangoproject.com/en/1.11/releases/1.11/#backwards-incompatible-changes-in-1-11) then it doesn't specify which version the changes are incompatible with. Firstly, (for LTS releases at least) it would be good to say something like 'changes since version 1.10'. Secondly, for LTS releases, it would be ideal to 'roll up' all backwards incompatible changes (or even all changes) since the last LTS, or, failing that, include links to all of the release notes since the previous LTS.

Change History (6)

comment:1 Changed 5 years ago by Tim Graham

Summary: Release notes should detail which version they're 'coming from' and LTS release notes should include/link all changes since previous LTSDocument the recommended way to upgrade Django from LTS to LTS
Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

The recommended way to upgrade from LTS to LTS is to upgrade one major version at a time, e.g. 1.8.x -> 1.9.y -> 1.10.z -> 1.11.a. This could be documented in docs/howto/upgrade-version.txt.

At the top of the release notes, it says something like "as well as some backwards incompatible changes you’ll want to be aware of when upgrading from Django 1.10 or older versions." I think it's fairly obvious that the LTS release notes don't roll up all changes since the previous LTS. At least, I haven't seen anyone else confused about that. The upgrade guide has a link to the release notes index page, so I also don't see a need to repeat links to the release notes for versions since the last LTS on the release notes for an LTS.

comment:2 Changed 5 years ago by Emmanuel

Owner: changed from nobody to Emmanuel
Status: newassigned

comment:3 Changed 5 years ago by Tim Graham

Has patch: set

comment:4 Changed 5 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: assignedclosed

In 27ef04bb:

Fixed #28349 -- Doc'd how to upgrade Django from LTS to LTS.

comment:5 Changed 5 years ago by Tim Graham <timograham@…>

In b6620de:

[1.11.x] Fixed #28349 -- Doc'd how to upgrade Django from LTS to LTS.

Backport of 27ef04bb5c3118e00d3eda4b3aa3201d18ea1785 from master

comment:6 Changed 5 years ago by Emmanuel

The document was updated with the intruction to update django using pip -U

Note: See TracTickets for help on using tickets.
Back to Top