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 !
Il peut être nécessaire d’effectuer trois différents types de publications :
La version courte des étapes à suivre est :
djangoproject.com
.djangoproject.com
.Il y a beaucoup de détails, accrochez-vous !
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
$ python -m 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.
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.
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 :
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.
As the release approaches, watch Trac to make sure no release blockers are left for the upcoming release.
Check with the other mergers to make sure they don’t have any uncommitted changes for the release.
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.
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.
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
.
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.
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.
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 3.1
$ git checkout -b stable/3.1.x origin/main
$ git push origin -u stable/3.1.x:stable/3.1.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.
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 2.2:
$ git checkout -b stable/2.2.x origin/stable/2.1.x
$ git push origin stable/2.2.x:stable/2.2.x
É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.
OK, voilà donc la partie amusante où nous allons réellement produire une nouvelle version !
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.
Une 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
$ git checkout stable/1.5.x
$ git pull
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/1.5.x
$ git merge --ff-only security/1.5.x
(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
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).
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.
Update the version number in django/__init__.py
for the release.
Please see notes on setting the VERSION tuple below for details
on VERSION
.
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
.
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>
.
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
$ cd dist
$ md5sum *
$ sha1sum *
$ sha256sum *
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/<<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>>
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.
Vous êtes maintenant prêt à publier les nouveaux paquets. Pour cela :
Té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
$ 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.
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
Test that the release packages install correctly using pip
. Here’s one
method:
$ RELEASE_VERSION='1.7.2'
$ 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
This just tests that the tarballs are available (i.e. redirects are up) and that they install correctly, but it’ll catch silly mistakes.
Ask a few people on IRC to verify the checksums by visiting the checksums
file (e.g. https://media.djangoproject.com/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).
Upload the release packages to PyPI (for pre-releases, only upload the wheel file):
$ twine upload -s dist/*
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.
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 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
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 2.2:
$ git checkout stable/2.2.x
$ git pull
$ python manage_translations.py robots_txt
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, 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.
Add a link to the blog post in the topic of the #django
IRC channel:
/msg chanserv TOPIC #django new topic goes here
.
Vous êtes presque au bout ! Tout ce qui reste à faire est :
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)
.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
.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.
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.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)... 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.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 :
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 »mars 08, 2023