How is Django Formed?

This document explains how to release Django.

Please, keep these instructions up-to-date if you make changes! The pointhere is to be descriptive, not prescriptive, so feel free to streamline orotherwise make changes, but update this document accordingly!

概况

There are three types of releases that you might need to make:

  • Security releases: disclosing and fixing a vulnerability. This'llgenerally involve two or three simultaneous releases — e.g.1.5.x, 1.6.x, and, depending on timing, perhaps a 1.7 alpha/beta/rc.
  • Regular version releases: either a final release (e.g. 1.5) or abugfix update (e.g. 1.5.1).

  • Pre-releases: e.g. 1.6 alpha, beta, or rc.
    The short version of the steps involved is:

  • If this is a security release, pre-notify the security distribution listone week before the actual release.

  • Proofread the release notes, looking for organization and writing errors.Draft a blog post and email announcement.
  • Update version numbers and create the release package(s).
  • Upload the package(s) to the djangoproject.com server.
  • Upload the new version(s) to PyPI.
  • Declare the new version in the admin on djangoproject.com.
  • Post the blog entry and send out the email announcements.
  • Update version numbers post-release.
    There are a lot of details, so please read on.

Prerequisites

You'll need a few things before getting started:

  • A GPG key. If the key you want to use is not your default signing key, you'llneed to add -u you@example.com to every GPG signing command below, whereyou@example.com is the email address associated with the key you want touse.

  • An install of some required Python packages:

  1. $ pip install wheel twine
  • Access to Django's record on PyPI. Create a file with your credentials:

~/.pypirc

  1. [pypi]
  2. username:YourUsername
  3. password:YourPassword

  • Access to the djangoproject.com server to upload files.

  • Access to the admin on djangoproject.com as a "Site maintainer".

  • Access to post to django-announce.

  • If this is a security release, access to the pre-notification distributionlist.

If this is your first release, you'll need to coordinate with another releaserto get all these things lined up.

Pre-release tasks

A few items need to be taken care of before even beginning the release process.This stuff starts about a week before the release; most of it can be doneany time leading up to the actual release:

  • If this is a security release, send out pre-notification one week beforethe release. The template for that email and a list of the recipients are inthe private django-security GitHub wiki. BCC the pre-notificationrecipients. Sign the email with the key you'll use for the release andinclude CVE IDs (requested with Vendor:djangoproject, Product: django) and patches for each issue being fixed.Also, notify django-announce of the upcomingsecurity release.

  • As the release approaches, watch Trac to make sure no release blockersare left for the upcoming release.

  • Check with the other committers to make sure they don't have anyuncommitted changes for the release.

  • Proofread the release notes, including looking at the onlineversion to catch any broken links or reST errors, and make sure therelease notes contain the correct date.

  • Double-check that the release notes mention deprecation timelinesfor any APIs noted as deprecated, and that they mention any changesin Python version support.

  • Double-check that the release notes index has a link to the notesfor the new release; this will be in docs/releases/index.txt.

  • If this is a feature release, ensure translations from Transifex have beenintegrated. This is typically done by a separate translation's managerrather than the releaser, but here are the steps. Provided you have anaccount on Transifex:

  1. $ python scripts/manage_translations.py fetch

and then commit the changed/added files (both .po and .mo). Sometimes thereare validation errors which need to be debugged, so avoid doing this taskimmediately before a release is needed.

  1. $ cd docs
  2. $ make man
  3. $ man _build/man/django-admin.1  # do a quick sanity check
  4. $ cp _build/man/django-admin.1 man/django-admin.1

and then commit the changed man page.

Preparing for release

Write the announcement blog post for the release. You can enter it into theadmin at any time and mark it as inactive. Here are a few examples: examplesecurity release announcement, example regular release announcement,example pre-release announcement.

Actually rolling the release

OK, this is the fun part, where we actually push out a release!

  • Check Jenkins is green for the version(s) you're putting out. Youprobably shouldn't issue a release until it's green.

  • A release always begins from a release branch, so you should make sureyou're on a stable branch and up-to-date. For example:

  1. $ git checkout stable/1.5.x
  2. $ git pull
  • If this is a security release, merge the appropriate patches fromdjango-security. Rebase these patches as necessary to make each one asimple commit on the release branch rather than a merge commit. To ensurethis, merge them with the —ff-only flag; for example:
  1. $ git checkout stable/1.5.x
  2. $ git merge --ff-only security/1.5.x

(This assumes security/1.5.x is a branch in the django-security repocontaining the necessary security patches for the next release in the 1.5series.)

If git refuses to merge with —ff-only, switch to the security-patchbranch and rebase it on the branch you are about to merge it into (git
checkout security/1.5.x; git rebase stable/1.5.x) and then switch back anddo the merge. Make sure the commit message for each security fix explainsthat the commit is a security fix and that an announcement will follow(example security commit).

  • For a feature release, remove the UNDER DEVELOPMENT header at thetop of the release notes and add the release date on the next line. For apatch release, replace Under Development with the release date. Makethis change on all branches where the release notes for a particular versionare located.

  • Update the version number in django/init.py for the release.Please see notes on setting the VERSION tuple below for detailson VERSION.

  • If this is a pre-release package, update the "Development Status" troveclassifier in setup.py to reflect this. Otherwise, make sure theclassifier is set to Development Status :: 5 - Production/Stable.

  • Tag the release using git tag. For example:

  1. $ git tag --sign --message="Tag 1.5.1" 1.5.1

You can check your work by running git tag —verify <tag>.

  • Push your work, including the tag: git push —tags.

  • Make sure you have an absolutely clean tree by running git clean -dfx.

  • Run make -f extras/Makefile to generate the release packages. This willcreate the release packages in a dist/ directory.

  • Generate the hashes of the release packages:

  1. $ cd dist
  2. $ md5sum *
  3. $ sha1sum *
  4. $ sha256sum *
  • Create a "checksums" file, Django-<<VERSION>>.checksum.txt containingthe hashes and release information. Start with this template and insert thecorrect version, date, GPG key ID (fromgpg —list-keys —keyid-format LONG), release URL, and checksums:
  1. This file contains MD5, SHA1, and SHA256 checksums for the source-code
  2. tarball and wheel files of Django <<VERSION>>, released <<DATE>>.
  3.  
  4. To use this file, you will need a working install of PGP or other
  5. compatible public-key encryption software. You will also need to have
  6. the Django release manager's public key in your keyring; this key has
  7. the ID ``XXXXXXXXXXXXXXXX`` and can be imported from the MIT
  8. keyserver. For example, if using the open-source GNU Privacy Guard
  9. implementation of PGP:
  10.  
  11.     gpg --keyserver pgp.mit.edu --recv-key XXXXXXXXXXXXXXXX
  12.  
  13. Once the key is imported, verify this file::
  14.  
  15.     gpg --verify <<THIS FILENAME>>
  16.  
  17. Once you have verified this file, you can use normal MD5, SHA1, or SHA256
  18. checksumming applications to generate the checksums of the Django
  19. package and compare them to the checksums listed below.
  20.  
  21. Release packages:
  22. =================
  23.  
  24. https://www.djangoproject.com/m/releases/<<RELEASE TAR.GZ FILENAME>>
  25. https://www.djangoproject.com/m/releases/<<RELEASE WHL FILENAME>>
  26.  
  27. MD5 checksums:
  28. ==============
  29.  
  30. <<MD5SUM>>  <<RELEASE TAR.GZ FILENAME>>
  31. <<MD5SUM>>  <<RELEASE WHL FILENAME>>
  32.  
  33. SHA1 checksums:
  34. ===============
  35.  
  36. <<SHA1SUM>>  <<RELEASE TAR.GZ FILENAME>>
  37. <<SHA1SUM>>  <<RELEASE WHL FILENAME>>
  38.  
  39. SHA256 checksums:
  40. =================
  41.  
  42. <<SHA256SUM>>  <<RELEASE TAR.GZ FILENAME>>
  43. <<SHA256SUM>>  <<RELEASE WHL FILENAME>>
  • Sign the checksum file (gpg —clearsign —digest-algo SHA256
    Django-<version>.checksum.txt    ). This generates a signed document,Django-<version>.checksum.txt.asc which you can then verify using gpg
    —verify Django-<version>.checksum.txt.asc    .

If you're issuing multiple releases, repeat these steps for each release.

Making the release(s) available to the public

Now you're ready to actually put the release out there. To do this:

  • Upload the release package(s) to the djangoproject server, replacingA.B. with the appropriate version number, e.g. 1.5 for a 1.5.x release:
  1. $ scp Django-* djangoproject.com:/home/www/www/media/releases/A.B
  • Upload the checksum file(s):
  1. $ scp Django-A.B.C.checksum.txt.asc djangoproject.com:/home/www/www/media/pgp/Django-A.B.C.checksum.txt
  • Test that the release packages install correctly using easy_installand pip. Here's one method (which requires virtualenvwrapper):
  1. $ RELEASE_VERSION='1.7.2'
  2. $ MAJOR_VERSION=`echo $RELEASE_VERSION| cut -c 1-3`
  3.  
  4. $ mktmpenv
  5. $ easy_install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz
  6. $ deactivate
  7. $ mktmpenv
  8. $ pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz
  9. $ deactivate
  10. $ mktmpenv
  11. $ pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION-py3-none-any.whl
  12. $ deactivate

This just tests that the tarballs are available (i.e. redirects are up) andthat they install correctly, but it'll catch silly mistakes.

  • Ask a few people on IRC to verify the checksums by visiting the checksumsfile (e.g. https://www.djangoproject.com/m/pgp/Django-1.5b1.checksum.txt)and following the instructions in it. For bonus points, they can also unpackthe downloaded release tarball and verify that its contents appear to becorrect (proper version numbers, no stray .pyc or other undesirablefiles).

  • Upload the release packages to PyPI (for pre-releases, only upload the wheelfile):

  1. $ twine upload -s dist/*

  • Go to the Add release page in the admin, enter the new release numberexactly as it appears in the name of the tarball (Django-.tar.gz).So for example enter "1.5.1" or "1.4c2", etc. If the release is part ofan LTS branch, mark it so.

  • Make the blog post announcing the release live.

  • For a new version release (e.g. 1.5, 1.6), update the default stable versionof the docs by flipping the is_default flag to True on theappropriate DocumentRelease object in the docs.djangoproject.comdatabase (this will automatically flip it to False for allothers); you can do this using the site's admin.

Create new DocumentRelease objects for each language that has an entryfor the previous release. Update djangoproject.com's robots.docs.txtfile by copying entries from the previous release.

Post-release

You're almost done! All that's left to do now is:

  • Update the VERSION tuple in django/init.py again,incrementing to whatever the next expected release will be. Forexample, after releasing 1.5.1, update VERSION toVERSION = (1, 5, 2, 'alpha', 0).
  • Add the release in Trac's versions list if necessary (and make it thedefault if it's a final release). Not all versions are declared;take example on previous releases.
  • If this was a security release, update Archive of security issues withdetails of the issues addressed.

New stable branch tasks

There are several items to do in the time following the creation of a newstable branch (often following an alpha release). Some of these tasks don'tneed to be done by the releaser.

  • Create a new DocumentRelease object in the docs.djangoproject.comdatabase for the new version's docs, and update thedocs/fixtures/doc_releases.json JSON fixture, so people without accessto the production DB can still run an up-to-date copy of the docs site.
  • Create a stub release note for the new feature version. Use the stub fromthe previous feature release version or copy the contents from the previousfeature version and delete most of the contents leaving only the headings.
  • Increase the default PBKDF2 iterations indjango.contrib.auth.hashers.PBKDF2PasswordHasher by about 20%(pick a round number). Run the tests, and update the 3 failinghasher tests with the new values. Make sure this gets noted in therelease notes (see the 1.8 release notes for an example).
  • Remove features that have reached the end of their deprecation cycle. Eachremoval should be done in a separate commit for clarity. In the commitmessage, add a "refs #XXXX" to the original ticket where the deprecationbegan if possible.
  • Remove .. versionadded::, .. versionadded::, and .. deprecated::annotations in the documentation from two releases ago. For example, inDjango 1.9, notes for 1.7 will be removed.
  • Add the new branch to Read the Docs. Since the automaticallygenerated version names ("stable-A.B.x") differ from the version numberswe've used historically in Read the Docs ("A.B.x"), we currently ask EricHolscher to add the version for us. Someday the alias functionality may bebuilt-in to the Read the Docs UI.

Notes on setting the VERSION tuple

Django's version reporting is controlled by the VERSION tuple indjango/init.py. This is a five-element tuple, whose elementsare:

  • Major version.
  • Minor version.
  • Micro version.
  • Status — can be one of "alpha", "beta", "rc" or "final".
  • Series number, for alpha/beta/RC packages which run in sequence(allowing, for example, "beta 1", "beta 2", etc.).
    For a final release, the status is always "final" and the seriesnumber is always 0. A series number of 0 with an "alpha" status willbe reported as "pre-alpha".

Some examples:

  • (1, 2, 1, 'final', 0) → "1.2.1"
  • (1, 3, 0, 'alpha', 0) → "1.3 pre-alpha"
  • (1, 3, 0, 'beta', 2) → "1.3 beta 2"