Ce document explique comment est réalisée une publication de Django.
\nVeuillez 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 !
\nIl peut être nécessaire d’effectuer trois différents types de publications :
\nPublications 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 :
\nS’il s’agit d’une publication de sécurité, prénotifier la liste de distribution de sécurité une semaine avant la publication effective.
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.
Mettre à jour les numéros de version et créer le ou les paquets de la publication.
Envoyer le ou les paquets sur le serveur djangoproject.com.
Envoyer la ou les nouvelles versions au serveur PyPI.
Déclarer la nouvelle version dans l’interface d’administration de djangoproject.com.
Publier l’article de blog et envoyer le courriel d’annonce.
Mettre à jour les numéros de version après la publication.
Il y a beaucoup de détails, accrochez-vous !
\nVous avez besoin d’un certain nombre de choses avant de commencer :
\nUne 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
\n$ python -m pip install wheel twine\nUn accès au compte Django sur PyPI. Créez un fichier avec vos informations d’authentification :
\n~/.pypirc[pypi]\nusername:YourUsername\npassword:YourPassword\nUn 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.
\nIl 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 :
\nIf this is a security release, send out pre-notification one week before\nthe release. The template for that email and a list of the recipients are in\nthe private django-security GitHub wiki. BCC the pre-notification\nrecipients. Sign the email with the key you’ll use for the release and\ninclude CVE IDs (requested with Vendor:\ndjangoproject, Product: django) and patches for each issue being fixed.\nAlso, notify django-announce of the upcoming\nsecurity release.
As the release approaches, watch Trac to make sure no release blockers\nare left for the upcoming release.
Check with the other mergers to make sure they don’t have any uncommitted\nchanges for the release.
Proofread the release notes, including looking at the online version to\ncatch any broken links or reST errors, and\nmake sure the release notes contain the correct date.
Double-check that the release notes mention deprecation timelines\nfor any APIs noted as deprecated, and that they mention any changes\nin Python version support.
Double-check that the release notes index has a link to the notes\nfor the new release; this will be in docs/releases/index.txt.
If this is a feature release, ensure translations from Transifex have been\nintegrated. This is typically done by a separate translation’s manager\nrather than the releaser, but here are the steps. Provided you have an\naccount on Transifex:
\n$ python scripts/manage_translations.py fetch\nand then commit the changed/added files (both .po and .mo).\nSometimes there are validation errors which need to be debugged, so avoid\ndoing this task immediately before a release is needed.
Mettez à jour la page de manuel de django-admin:
\n$ cd docs\n$ make man\n$ man _build/man/django-admin.1 # do a quick sanity check\n$ cp _build/man/django-admin.1 man/django-admin.1\npuis faites le commit de la page de manuel modifiée.
\nS’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 3.1
$ git checkout -b stable/3.1.x origin/main\n$ git push origin -u stable/3.1.x:stable/3.1.x\nAt the same time, update the django_next_version variable in\ndocs/conf.py on the stable release branch to point to the new\ndevelopment version. For example, when creating stable/4.2.x, set\ndjango_next_version to '5.0' on the new branch.
If this is the « dot zero » release of a new series, create a new branch from\nthe current stable branch in the django-docs-translations repository. For\nexample, when releasing Django 2.2:
\n$ git checkout -b stable/2.2.x origin/stable/2.1.x\n$ git push origin stable/2.2.x:stable/2.2.x\nÉ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.
\nOK, voilà donc la partie amusante où nous allons réellement produire une nouvelle version !
\nVé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.
\nUne nouvelle version se base toujours sur une branche de versions, vous devriez donc vérifier que vous vous trouvez sur une branche stable et à jour. Par exemple
\n$ git checkout stable/1.5.x\n$ git pull\nIf this is a security release, merge the appropriate patches from\ndjango-security. Rebase these patches as necessary to make each one a\nplain commit on the release branch rather than a merge commit. To ensure\nthis, merge them with the --ff-only flag; for example:
$ git checkout stable/1.5.x\n$ git merge --ff-only security/1.5.x\n(Cela suppose que security/1.5.x est une branche du dépôt django-security contenant les correctifs de sécurité nécessaires pour la prochaine publication de la série 1.5).
If git refuses to merge with --ff-only, switch to the security-patch\nbranch and rebase it on the branch you are about to merge it into (git\ncheckout security/1.5.x; git rebase stable/1.5.x) and then switch back and\ndo the merge. Make sure the commit message for each security fix explains\nthat the commit is a security fix and that an announcement will follow\n(example security commit).
For a feature release, remove the UNDER DEVELOPMENT header at the\ntop of the release notes and add the release date on the next line. For a\npatch release, replace *Under Development* with the release date. Make\nthis change on all branches where the release notes for a particular version\nare located.
Update the version number in django/__init__.py for the release.\nPlease see notes on setting the VERSION tuple below for details\non VERSION.
If this is a pre-release package, update the « Development Status » trove\nclassifier in setup.cfg to reflect this. Otherwise, make sure the\nclassifier is set to Development Status :: 5 - Production/Stable.
Tag the release using git tag. For example:
$ git tag --sign --message="Tag 1.5.1" 1.5.1\nYou can check your work by running git tag --verify <tag>.
Push your work, including the tag: git push --tags.
Assurez-vous d’avoir une arborescence parfaitement propre en exécutant git clean -dfx.
Lancez make -f extras/Makefile pour générer les paquets à publier. Ces paquets seront créés dans un répertoire dist/.
Générez les empreintes des paquets à publier
\n$ cd dist\n$ md5sum *\n$ sha1sum *\n$ sha256sum *\nCré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\ntarball and wheel files of Django <<VERSION>>, released <<DATE>>.\n\nTo use this file, you will need a working install of PGP or other\ncompatible public-key encryption software. You will also need to have\nthe Django release manager's public key in your keyring. This key has\nthe ID ``XXXXXXXXXXXXXXXX`` and can be imported from the MIT\nkeyserver, for example, if using the open-source GNU Privacy Guard\nimplementation of PGP:\n\n gpg --keyserver pgp.mit.edu --recv-key XXXXXXXXXXXXXXXX\n\nor via the GitHub API:\n\n curl https://github.com/<<RELEASE MANAGER GITHUB USERNAME>>.gpg | gpg --import -\n\nOnce the key is imported, verify this file:\n\n gpg --verify <<THIS FILENAME>>\n\nOnce you have verified this file, you can use normal MD5, SHA1, or SHA256\nchecksumming applications to generate the checksums of the Django\npackage and compare them to the checksums listed below.\n\nRelease packages:\n=================\n\nhttps://www.djangoproject.com/m/releases/<<RELEASE TAR.GZ FILENAME>>\nhttps://www.djangoproject.com/m/releases/<<RELEASE WHL FILENAME>>\n\nMD5 checksums:\n==============\n\n<<MD5SUM>> <<RELEASE TAR.GZ FILENAME>>\n<<MD5SUM>> <<RELEASE WHL FILENAME>>\n\nSHA1 checksums:\n===============\n\n<<SHA1SUM>> <<RELEASE TAR.GZ FILENAME>>\n<<SHA1SUM>> <<RELEASE WHL FILENAME>>\n\nSHA256 checksums:\n=================\n\n<<SHA256SUM>> <<RELEASE TAR.GZ FILENAME>>\n<<SHA256SUM>> <<RELEASE WHL FILENAME>>\nSignez 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.
\nVous êtes maintenant prêt à publier les nouveaux paquets. Pour cela :
\nTéléversez les paquets à publier sur le serveur djangoproject, en remplaçant A.B. par le numéro de version approprié, par ex. 1.5 pour une publication 1.5.x
\n$ scp Django-* djangoproject.com:/home/www/www/media/releases/A.B\nS’il s’agit de la publication alpha d’une nouvelle série, vous devrez créer le répertoire A.B.
\nTéléversez les fichiers de sommes de contrôle
\n$ scp Django-A.B.C.checksum.txt.asc djangoproject.com:/home/www/www/media/pgp/Django-A.B.C.checksum.txt\nTest that the release packages install correctly using pip. Here’s one\nmethod:
$ RELEASE_VERSION='1.7.2'\n$ MAJOR_VERSION=`echo $RELEASE_VERSION| cut -c 1-3`\n\n$ python -m venv django-pip\n$ . django-pip/bin/activate\n$ python -m pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz\n$ deactivate\n$ python -m venv django-pip-wheel\n$ . django-pip-wheel/bin/activate\n$ python -m pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION-py3-none-any.whl\n$ deactivate\nThis just tests that the tarballs are available (i.e. redirects are up) and\nthat they install correctly, but it’ll catch silly mistakes.
\nAsk a few people on IRC to verify the checksums by visiting the checksums\nfile (e.g. https://media.djangoproject.com/pgp/Django-1.5b1.checksum.txt)\nand following the instructions in it. For bonus points, they can also unpack\nthe downloaded release tarball and verify that its contents appear to be\ncorrect (proper version numbers, no stray .pyc or other undesirable\nfiles).
Upload the release packages to PyPI (for pre-releases, only upload the wheel\nfile):
\n$ twine upload -s dist/*\nGo to the Add release page in the admin, enter the new release number\nexactly as it appears in the name of the tarball\n(Django-<version>.tar.gz). So for example enter « 1.5.1 » or « 1.4c2 », etc.\nIf 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\nfor the final release, ensuring that the Release date field is blank,\nthus marking it as unreleased. For example, when creating the Release\nobject for 3.1a1, also create 3.1 with the Release date field blank.
Make the blog post announcing the release live.
For a new version release (e.g. 1.5, 1.6), update the default stable version\nof the docs by flipping the is_default flag to True on the\nappropriate DocumentRelease object in the docs.djangoproject.com\ndatabase (this will automatically flip it to False for all\nothers); you can do this using the site’s admin.
Create new DocumentRelease objects for each language that has an entry\nfor the previous release. Update djangoproject.com’s robots.docs.txt\nfile by copying entries from manage_translations.py robots_txt from the\ncurrent stable branch in the django-docs-translations repository. For\nexample, when releasing Django 2.2:
$ git checkout stable/2.2.x\n$ git pull\n$ python manage_translations.py robots_txt\nPost the release announcement to the django-announce, django-developers,\nand django-users mailing lists. This should include a link to the\nannouncement blog post.
If this is a security release, send a separate email to\noss-security@lists.openwall.com. Provide a descriptive subject, for example,\n« Django » plus the issue title from the release notes (including CVE ID). The\nmessage body should include the vulnerability details, for example, the\nannouncement blog post text. Include a link to the announcement blog post.
Add a link to the blog post in the topic of the #django IRC channel:\n/msg chanserv TOPIC #django new topic goes here.
Vous êtes presque au bout ! Tout ce qui reste à faire est :
\nMettre à 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 1.5.1, mettez à jour VERSION à VERSION = (1, 5, 2, 'alpha', 0).
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.
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.
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.
\nCré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.
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.
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 1.8).
Remove features that have reached the end of their deprecation cycle. Each\nremoval should be done in a separate commit for clarity. In the commit\nmessage, add a « refs #XXXX » to the original ticket where the deprecation\nbegan if possible.
Supprimez les annotations .. versionadded::, .. versionadded:: et .. deprecated:: dans la documentation concernant l’avant-dernière publication. Par exemple, dans Django 1.9, les notes pour 1.7 seront supprimées.
Add the new branch to Read the Docs. Since the automatically\ngenerated version names (« stable-A.B.x ») differ from the version names\nused in Read the Docs (« A.B.x »), create a ticket requesting\nthe new version.
Demandez la nouvelle classification sur PyPI. Par exemple, Framework :: Django :: 3.1.
La version de Django est contrôlée par le tuple VERSION dans django/__init__.py. C’est un tuple à cinq éléments, contenant :
La version majeure.
La version mineure.
La version micro.
Le statut, qui peut-être « alpha », « beta », « rc » ou « final ».
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 ».
\nQuelques exemples :
\n(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 »