Comment est constitué Django ?¶

Aperçu¶

Il peut être nécessaire d’effectuer trois différents types de publications :

• Publications de sécurité : annonce et résolution d’une vulnérabilité. Cela implique généralement deux ou trois publications simultanées – par ex. 1.5.x, 1.6.x et selon le timing, peut-être une 1.7 alpha/beta/rc.
• Publications de version normale : soit une publication finale (par ex. 1.5) ou une mise à jour corrective (par ex. 1.5.1).
• Prépublications : par ex. 1.6 alpha, bêta ou rc.

La version courte des étapes à suivre est :

1. S’il s’agit d’une publication de sécurité, prénotifier la liste de distribution de sécurité une semaine avant la publication effective.
2. Relire les notes de publication, particulièrement en ce qui concerne leur organisation et leur formulation. Écrire un brouillon d’article de blog et de courriel d’annonce.
3. Mettre à jour les numéros de version et créer le ou les paquets de la publication.
4. Envoyer le ou les paquets sur le serveur djangoproject.com.
5. Envoyer la ou les nouvelles versions au serveur PyPI.
6. Déclarer la nouvelle version dans l’interface d’administration de djangoproject.com.
7. Publier l’article de blog et envoyer le courriel d’annonce.
8. Mettre à jour les numéros de version après la publication.

Il y a beaucoup de détails, accrochez-vous !

Prérequis¶

Vous avez besoin d’un certain nombre de choses avant de commencer :

• Une clé GPG. Si la clé que vous souhaitez utiliser n’est pas votre clé de signature par défaut, vous devrez ajouter -u vous@example.com à chaque commande de signature GPG ci-dessous, où vous@example.com est l’adresse de courriel associée à la clé que vous allez utiliser.

• Une installation de quelques paquets Python indispensables

  $ pip install wheel twine
  

• Un accès au compte Django sur PyPI. Créez un fichier avec vos informations d’authentification :

  ~/.pypirc¶

  [pypi]
  username:YourUsername
  password:YourPassword
  

• Un accès au serveur djangoproject.com pour y envoyer des fichiers.

• Un accès à l’interface d’administration de djangoproject.com comme « mainteneur de site ».

• Un droit de publication sur django-announce.

• S’il s’agit d’une publication de sécurité, un accès à la liste de distribution de prénotification.

If this is your first release, you’ll need to coordinate with another releaser to 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 done any time leading up to the actual release:

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

2. As the release approaches, watch Trac to make sure no release blockers are left for the upcoming release.

3. Check with the other committers to make sure they don’t have any uncommitted changes for the release.

4. Proofread the release notes, including looking at the online version to catch any broken links or reST errors, and make sure the release notes contain the correct date.

5. Double-check that the release notes mention deprecation timelines for any APIs noted as deprecated, and that they mention any changes in Python version support.

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

7. If this is a feature release, ensure translations from Transifex have been integrated. This is typically done by a separate translation’s manager rather than the releaser, but here are the steps. Provided you have an account on Transifex:

   $ python scripts/manage_translations.py fetch
   

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

8. Update the django-admin manual page:

   $ cd docs
   $ make man
   $ man _build/man/django-admin.1  # do a quick sanity check
   $ 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 the admin at any time and mark it as inactive. Here are a few examples: example security 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!

1. Check Jenkins is green for the version(s) you’re putting out. You probably shouldn’t issue a release until it’s green.

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

   $ git checkout stable/1.5.x
   $ git pull
   

3. If this is a security release, merge the appropriate patches from django-security. Rebase these patches as necessary to make each one a simple commit on the release branch rather than a merge commit. To ensure this, merge them with the --ff-only flag; for example:

   $ git checkout stable/1.5.x
   $ git merge --ff-only security/1.5.x
   

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

   If git refuses to merge with --ff-only, switch to the security-patch branch 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 and do the merge. Make sure the commit message for each security fix explains that the commit is a security fix and that an announcement will follow (example security commit).

4. For a feature release, remove the UNDER DEVELOPMENT header at the top of the release notes and add the release date on the next line. For a patch release, replace *Under Development* with the release date. Make this change on all branches where the release notes for a particular version are located.

5. Update the version number in django/__init__.py for the release. Please see notes on setting the VERSION tuple below for details on VERSION.

6. If this is a pre-release package, update the « Development Status » trove classifier in setup.py to reflect this. Otherwise, make sure the classifier is set to Development Status :: 5 - Production/Stable.

7. Tag the release using git tag. For example:

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

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

8. Push your work, including the tag: git push --tags.

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

10. Run make -f extras/Makefile to generate the release packages. This will create the release packages in a dist/ directory.

11. Generate the hashes of the release packages:

    $ cd dist
    $ md5sum *
    $ sha1sum *
    $ sha256sum *
    

12. Create a « checksums » file, Django-<<VERSION>>.checksum.txt containing the hashes and release information. Start with this template and insert the correct version, date, GPG key ID (from gpg --list-keys --keyid-format LONG), release URL, and checksums:

    This file contains MD5, SHA1, and SHA256 checksums for the source-code
    tarball and wheel files of Django <<VERSION>>, released <<DATE>>.
    
    To use this file, you will need a working install of PGP or other
    compatible public-key encryption software. You will also need to have
    the Django release manager's public key in your keyring; this key has
    the ID ``XXXXXXXXXXXXXXXX`` and can be imported from the MIT
    keyserver. For example, if using the open-source GNU Privacy Guard
    implementation of PGP:
    
        gpg --keyserver pgp.mit.edu --recv-key XXXXXXXXXXXXXXXX
    
    Once the key is imported, verify this file::
    
        gpg --verify <<THIS FILENAME>>
    
    Once you have verified this file, you can use normal MD5, SHA1, or SHA256
    checksumming applications to generate the checksums of the Django
    package and compare them to the checksums listed below.
    
    Release packages:
    =================
    
    https://www.djangoproject.com/m/releases/<<RELEASE TAR.GZ FILENAME>>
    https://www.djangoproject.com/m/releases/<<RELEASE WHL FILENAME>>
    
    MD5 checksums:
    ==============
    
    <<MD5SUM>>  <<RELEASE TAR.GZ FILENAME>>
    <<MD5SUM>>  <<RELEASE WHL FILENAME>>
    
    SHA1 checksums:
    ===============
    
    <<SHA1SUM>>  <<RELEASE TAR.GZ FILENAME>>
    <<SHA1SUM>>  <<RELEASE WHL FILENAME>>
    
    SHA256 checksums:
    =================
    
    <<SHA256SUM>>  <<RELEASE TAR.GZ FILENAME>>
    <<SHA256SUM>>  <<RELEASE WHL FILENAME>>
    

13. 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:

1. Upload the release package(s) to the djangoproject server, replacing A.B. with the appropriate version number, e.g. 1.5 for a 1.5.x release:

   $ scp Django-* djangoproject.com:/home/www/www/media/releases/A.B
   

2. Upload the checksum file(s):

   $ scp Django-A.B.C.checksum.txt.asc djangoproject.com:/home/www/www/media/pgp/Django-A.B.C.checksum.txt
   

3. Test that the release packages install correctly using easy_install and pip. Here’s one method (which requires virtualenvwrapper):

   $ RELEASE_VERSION='1.7.2'
   $ MAJOR_VERSION=`echo $RELEASE_VERSION| cut -c 1-3`
   
   $ mktmpenv
   $ easy_install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz
   $ deactivate
   $ mktmpenv
   $ pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz
   $ deactivate
   $ mktmpenv
   $ pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION-py3-none-any.whl
   $ deactivate
   

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

4. Ask a few people on IRC to verify the checksums by visiting the checksums file (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 unpack the downloaded release tarball and verify that its contents appear to be correct (proper version numbers, no stray .pyc or other undesirable files).

5. Upload the release packages to PyPI (for pre-releases, only upload the wheel file):

   $ twine upload -s dist/*
   

6. Go to the Add release page in the admin, enter the new release number exactly as it appears in the name of the tarball (Django-<version>.tar.gz). So for example enter « 1.5.1 » or « 1.4c2 », etc. If the release is part of an LTS branch, mark it so.

7. Make the blog post announcing the release live.

8. For a new version release (e.g. 1.5, 1.6), update the default stable version of the docs by flipping the is_default flag to True on the appropriate DocumentRelease object in the docs.djangoproject.com database (this will automatically flip it to False for all others); you can do this using the site’s admin.

   Create new DocumentRelease objects for each language that has an entry for the previous release. Update djangoproject.com’s robots.docs.txt file by copying entries from the previous release.

9. Post the release announcement to the django-announce, django-developers, and django-users mailing lists. This should include a link to the announcement blog post. If this is a security release, also include oss-security@lists.openwall.com.

10. Add a link to the blog post in the topic of the #django IRC channel: /msg chanserv TOPIC #django new topic goes here.

Post-release¶

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

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

New stable branch tasks¶

There are several items to do in the time following the creation of a new stable branch (often following an alpha release). Some of these tasks don’t need to be done by the releaser.

1. Create a new DocumentRelease object in the docs.djangoproject.com database for the new version’s docs, and update the docs/fixtures/doc_releases.json JSON fixture, so people without access to the production DB can still run an up-to-date copy of the docs site.
2. Create a stub release note for the new feature version. Use the stub from the previous feature release version or copy the contents from the previous feature version and delete most of the contents leaving only the headings.
3. Increase the default PBKDF2 iterations in django.contrib.auth.hashers.PBKDF2PasswordHasher by about 20% (pick a round number). Run the tests, and update the 3 failing hasher tests with the new values. Make sure this gets noted in the release notes (see the 1.8 release notes for an example).
4. Remove features that have reached the end of their deprecation cycle. Each removal should be done in a separate commit for clarity. In the commit message, add a « refs #XXXX » to the original ticket where the deprecation began if possible.
5. Remove .. versionadded::, .. versionadded::, and .. deprecated:: annotations in the documentation from two releases ago. For example, in Django 1.9, notes for 1.7 will be removed.
6. Add the new branch to Read the Docs. Since the automatically generated version names (« stable-A.B.x ») differ from the version numbers we’ve used historically in Read the Docs (« A.B.x »), we currently ask Eric Holscher to add the version for us. Someday the alias functionality may be built-in to the Read the Docs UI.

Notes on setting the VERSION tuple¶

La version de Django est contrôlée par le tuple VERSION dans django/__init__.py. C’est un tuple à cinq éléments, contenant :

1. La version majeure.
2. La version mineure.
3. La version micro.
4. Le statut, qui peut-être « alpha », « beta », « rc » ou « final ».
5. Le numéro de série, dans le cas des versions alpha/beta/RC qui se font suite (autorisant, par exemple, « beta 1 », « beta 2 », etc.).

Pour une version finale, le statut est toujours « final » et le numéro de série 0. Un numéro de série à 0 avec le statut « alpha » est signalé comme une « pre-alpha ».

Quelques exemples :

• (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 »