Comment est constitué Django ?

Ce document explique comment est réalisée une publication de Django.

Veuillez s’il-vous-plaît garder ces instructions à jour si vous procédez à des modifications ! La clé ici est d’être descriptif et non pas normatif, sentez-vous donc libre de simplifier ou de faire d’autres changements dans la procédure, mais alors mettez à jour ce document en fonction !

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. 3.2.x, 4.0.x et selon le timing, peut-être une 4.1.x.
  • Publications de version normale : soit une publication finale (par ex. 4.1) ou une mise à jour corrective (par ex. 4.1.1).
  • Prépublications : par ex. 4.2 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. Vérifier les signatures du ou des paquets, contrôler s’ils peuvent être installés et s’assurer de leur fonctionnement minimal.
  6. Envoyer la ou les nouvelles versions au serveur PyPI.
  7. Déclarer la nouvelle version dans l’interface d’administration de djangoproject.com.
  8. Publier l’article de blog et envoyer le courriel d’annonce.
  9. 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. Vous devrez aussi ajouter -i vous@exemple.com à votre appel à twine.

  • Une installation de quelques paquets Python indispensables :

    $ python -m pip install wheel twine

  • Un accès au projet Django sur PyPI. Créez un jeton de portée de projet en suivant la documentation officielle et configurez votre fichier $HOME/.pypirc comme ceci :

    ~/.pypirc
    [distutils]
  index-servers =
    pypi
    django

[pypi]
  username = __token__
  password = # User-scoped or project-scoped token, to set as the default.

[django]
  repository = https://upload.pypi.org/legacy/
  username = __token__
  password = # A project token.

  • 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.

S’il s’agit de votre première publication, vous devrez vous coordonner avec un autre publicateur pour que tous ces éléments soient au point.

Tâches de pré-publication

Il faut s’occuper de quelques tâches avant même de commencer le processus de publication en tant que tel. Celles-ci commencent environ une semaine avant la publication ; la plupart peuvent être réalisées à n’importe quel moment précédant la publication réelle :

  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 mergers 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. Mettez à jour la page de manuel de django-admin:

    $ 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

    puis faites le commit de la page de manuel modifiée.

  9. S’il s’agit de la version alpha d’une nouvelle série, créez une nouvelle branche stable à partir de main. Par exemple, lors de la publication de Django 4.2 :

    $ git checkout -b stable/4.2.x origin/main
$ git push origin -u stable/4.2.x:stable/4.2.x

    At the same time, update the django_next_version variable in docs/conf.py on the stable release branch to point to the new development version. For example, when creating stable/4.2.x, set django_next_version to '5.0' on the new branch.

  10. If this is the « dot zero » release of a new series, create a new branch from the current stable branch in the django-docs-translations repository. For example, when releasing Django 4.2:

    $ git checkout -b stable/4.2.x origin/stable/4.1.x
$ git push origin stable/4.2.x:stable/4.2.x

Préparation de la publication

Écrivez l’article de blog d’annonce de la publication. Vous pouvez l’écrire dans le site d’administration tout en le marquant comme inactif. Voici quelque exemples : exemple d’annonce de publication de sécurité, exemple d’annonce de publication normale, exemple d’annonce de pré-publication.

Production réelle de la nouvelle version

OK, voilà donc la partie amusante où nous allons réellement produire une nouvelle version !

  1. Vérifiez que Jenkins est vert pour la ou les versions que vous allez produire. Vous ne devriez probablement pas produire de version tant que ce n’est pas vert.

  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/4.1.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 plain 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/4.1.x
$ git merge --ff-only security/4.1.x

    (This assumes security/4.1.x is a branch in the django-security repo containing the necessary security patches for the next release in the 4.1 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/4.1.x; git rebase stable/4.1.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, remove the Expected prefix and update the release date, if necessary. 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.cfg to reflect this. Otherwise, make sure the classifier is set to Development Status :: 5 - Production/Stable.

  7. Placez une étiquette sur la publication avec git tag. Par exemple :

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

    Vous pouvez contrôler votre travail en exécutant git tag --verify <tag>.

  8. Poussez votre travail, y compris l’étiquette : git push --tags.

  9. Assurez-vous d’avoir une arborescence parfaitement propre en exécutant git clean -dfx.

  10. Lancez make -f extras/Makefile pour générer les paquets à publier. Ces paquets seront créés dans un répertoire dist/.

  11. Générez les empreintes des paquets à publier :

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

  12. Créez un fichier « checksums », Django-<<VERSION>>.checksum.txt` contenant les empreintes et les informations de publication. Commencez avec ce modèle et insérez la version correcte, la date, l’identifiant de clé GPG (provenant de gpg --list-keys --keyid-format LONG), le nom d’utilisateur de responsable de version GitHub, l’URL de publication et les sommes de contrôle :

    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

or via the GitHub API:

    curl https://github.com/<<RELEASE MANAGER GITHUB USERNAME>>.gpg | gpg --import -

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/<<MAJOR VERSION>>/<<RELEASE TAR.GZ FILENAME>>
https://www.djangoproject.com/m/releases/<<MAJOR VERSION>>/<<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. Signez le fichier de sommes de contrôle (gpg --clearsign --digest-algo SHA256 Django-<version>.checksum.txt). Cela produit un document signé, Django-<version>.checksum.txt.asc que vous pouvez ensuite vérifier avec gpg --verify Django-<version>.checksum.txt.asc.

Si vous produisez plusieurs publications, répétez ces étapes pour chaque publication.

Rendre la ou les publications publique(s)

Vous êtes maintenant prêt à publier les nouveaux paquets. Pour cela :

  1. Téléversez les paquets à publier sur le serveur djangoproject, en remplaçant A.B. par le numéro de version approprié, par ex. 4.1 pour une publication 4.1.x :

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

    S’il s’agit de la publication alpha d’une nouvelle série, vous devrez créer le répertoire A.B.

  2. Téléversez les fichiers de sommes de contrôle :

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

  3. Testez que les paquets de publication s’installent correctement avec pip. Voici l’une des méthodes :

    $ RELEASE_VERSION='4.1.1'
$ MAJOR_VERSION=`echo $RELEASE_VERSION| cut -c 1-3`

$ python -m venv django-pip
$ . django-pip/bin/activate
$ python -m pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz
$ deactivate
$ python -m venv django-pip-wheel
$ . django-pip-wheel/bin/activate
$ python -m pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION-py3-none-any.whl
$ deactivate

    Cela teste uniquement que les publications sont disponibles (i.e. les redirections sont actives) et qu’elles s’installent correctement, mais cela va au moins révéler d’éventuelles erreurs stupides.

  4. Lancez la construction confirm-release sur Jenkins pour vérifier les fichiers de sommes de contrôle (par ex. utilisez 4.2rc1 pour https://media.djangoproject.com/pgp/Django-4.2rc1.checksum.txt).

  5. Envoyez les paquets à publier vers PyPI (pour les prépublications, n’envoyez que le fichier wheel) :

    $ 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 « 4.1.1 » or « 4.2rc1 », etc. If the release is part of an LTS branch, mark it so.

    If this is the alpha release of a new series, also create a Release object for the final release, ensuring that the Release date field is blank, thus marking it as unreleased. For example, when creating the Release object for 4.2a1, also create 4.2 with the Release date field blank.

  7. Écrivez l’article de blog annonçant que la publication est en ligne.

  8. For a new version release (e.g. 4.1, 4.2), 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 manage_translations.py robots_txt from the current stable branch in the django-docs-translations repository. For example, when releasing Django 4.2:

    $ git checkout stable/4.2.x
$ git pull
$ python manage_translations.py robots_txt

  9. Post the release announcement to the django-announce, django-developers, django-users mailing lists, and the Django Forum. This should include a link to the announcement blog post.

  10. If this is a security release, send a separate email to oss-security@lists.openwall.com. Provide a descriptive subject, for example, « Django » plus the issue title from the release notes (including CVE ID). The message body should include the vulnerability details, for example, the announcement blog post text. Include a link to the announcement blog post.

  11. Ajoutez un lien vers l’article de blog dans le sujet du canal IRC #django: /msg chanserv TOPIC #django ici le nouveau sujet.

Après la publication

Vous êtes presque au bout ! Tout ce qui reste à faire est :

  1. Mettre à jour à nouveau le tuple VERSION dans django/__init__.py, en l’incrémentant à ce que la prochaine version devra donner. Par exemple, après la publication de 4.1.1, mettez à jour VERSION à VERSION = (4, 1, 2, 'alpha', 0).
  2. Ajoutez la version dans la liste des versions de Trac si nécessaire (et, s’il s’agit d’une version finale, mettez-la comme version par défaut en modifiant le réglage default_version dans le fichier trac.ini de code.djangoproject.com). La nouvelle version X.Y doit être ajoutée après la publication alpha et la version par défaut doit être mise à jour après la publication .0.
  3. S’il s’agit d’une nouvelle version majeure, mettez à jour la branche stable actuelle et enlevez les branches de pré-publication dans le processus de publication de Django sur Trac.
  4. S’il s’est agi d’une publication de sécurité, mettez à jour Archive des issues de sécurité avec les détails sur les problèmes corrigés.

Tâches pour les nouvelles versions stables

Il y a plusieurs choses à faire à la suite de la création d’une nouvelle branche stable (suivant en général une publication alpha). Certaines de ces tâches n’ont pas besoin d’être réalisées par le publicateur.

  1. Créez un nouvel objet DocumentRelease dans la base de données docs.djangoproject.com pour la documentation de la nouvelle version et mettez à jour l’instantané JSON docs/fixtures/doc_releases.json afin que les personnes sans accès à la base de données de production puissent tout de même faire fonctionner une copie à jour du site de documentation.
  2. Créez un squelette de notes de publication pour la nouvelle version majeure. Utilisez le modèle de l’ancienne version majeure ou copiez le contenu d’une précédente version majeure en supprimant la plupart de son contenu excepté les en-têtes.
  3. Augmentez le nombre d’itérations PBKDF2 par défaut dans django.contrib.auth.hashers.PBKDF2PasswordHasher d’environ 20% (en choisissant un chiffre rond). Lancez les tests et mettez à jour les 3 tests en échec liés aux empreintes avec les nouvelles valeurs. Assurez-vous que les notes de publication mentionnent cette augmentation (voir par exemple les notes de publication de la version 4.1).
  4. Enlevez les fonctionnalités qui ont atteint la fin de leur cycle d’obsolescence. Chaque suppression doit être appliquée dans un commit séparé pour plus de clarté. Dans le message de commit, ajoutez si possible la mention « refs #XXXX » pointant vers le ticket d’origine qui a provoqué l’obsolescence.
  5. Supprimez les annotations .. versionadded::, .. versionadded:: et .. deprecated:: dans la documentation concernant l’avant-dernière publication. Par exemple, dans Django 4.2, les notes pour 4.0 seront supprimées.
  6. Ajoutez la nouvelle branche sur Read the Docs. Comme les noms de versions automatiquement générés («stable-A.B.x») diffèrent des noms de versions utilisés dans Read the Docs («A.B.x»), créez un ticket demandant la nouvelle version.
  7. Demandez la nouvelle classification sur PyPI. Par exemple, Framework :: Django :: 3.1.
  8. Update the current branch under active development and add pre-release branch in the Django release process on Trac.

Notes sur la définition du tuple VERSION

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 :

  • (4, 1, 1, "final", 0) → « 4.1.1 »
  • (4, 2, 0, "alpha", 0) → « 4.2 pre-alpha »
  • (4, 2, 0, "beta", 1) → « 4.2 beta 1 »
Back to Top