How to release Django

Este documento explica como fazer uma release do Django.

Por favor, mantenha essas instruções atualizadas se você fizer mudanças! A ideia aqui é ser descritivo, não prescritivo, então sinta-se à vontade para agilizar ou por outro lado fazer mudanças, mas atualize este documento de acordo

Visão Geral

Existem três tipos de releases que você pode precisar fazer:

• Security releases: disclosing and fixing a vulnerability. This’ll generally involve two or three simultaneous releases – e.g. 3.2.x, 4.0.x, and, depending on timing, perhaps a 4.1.x.

• Regular version releases: either a final release (e.g. 4.1) or a bugfix update (e.g. 4.1.1).

• Pre-releases: e.g. 4.2 alpha, beta, or rc.

Uma curta versão dos passos envolvidos é a seguinte:

1. Se esta é uma release de segurança, pre-notificar a lista de distribuição de segurança uma semana antes da release atual.

2. Revisar as notas de release, buscando por melhor organização e erros de escrita. Esboçar um post de blog e um e-mail de anúncio.

3. Update version numbers and create the release artifacts.

4. Create the new Release in the admin on djangoproject.com.

   1. Set the proper date but ensure the flag is_active is disabled.

   2. Upload the artifacts (tarball, wheel, and checksums).

5. Verify package(s) signatures, check if they can be installed, and ensure minimal functionality.

6. Fazer upload da nova versão (ou versões) para o PyPI.

7. Enable the is_active flag for each release in the admin on djangoproject.com.

8. Postar a entrada no blog e enviar os anúncios de e-mail.

9. Update version numbers post-release in stable branch(es).

10. Add stub release notes for the next patch release in main and backport.

Existem vários detalhes, então por favor continue lendo.

Pré-requisitos

You’ll need a few things before getting started. If this is your first release, you’ll need to coordinate with another releaser to get all these things lined up, and write to the Ops mailing list requesting the required access and permissions.

• A Unix environment with these tools installed (in alphabetical order):

  • bash

  • git

  • GPG

  • make

  • man

  • hashing tools (typically md5sum, sha1sum, and sha256sum on Linux, or md5 and shasum on macOS)

  • python

• A GPG key pair. Ensure that the private part of this key is securely stored. The public part needs to be uploaded to your GitHub account, and also to the Jenkins server running the “confirm release” job.

  More than one GPG key

  If the key you want to use is not your default signing key, you’ll need to add -u [e-mail] to every GPG signing command shown below, where [e-mail] is the email address associated with the key you want to use.

• A clean Python virtual environment (Python 3.9+) to build artifacts, with these required Python packages installed:

  $ python -m pip install build twine
  

• Access to Django’s project on PyPI to upload binaries, ideally with extra permissions to yank a release if necessary. Create a project-scoped token following the official documentation and set up your $HOME/.pypirc file like this:

  ~/.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.
  

• Access to Django’s project on Transifex, with a Manager role. Generate an API Token in the user setting section and set up your $HOME/.transifexrc file like this:

  ~/.transifexrc

  [https://www.transifex.com]
    rest_hostname = https://rest.api.transifex.com
    token = # API token
  

• Access to the Django admin on djangoproject.com as a “Site maintainer”.

• Access to create a post in the Django Forum - Announcements category and to send emails to the django-announce mailing list.

• Access to the django-security repo in GitHub. Among other things, this provides access to the pre-notification distribution list (needed for security release preparation tasks).

• Access to the Django project on Read the Docs.

Tarefas de pré-release

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.

10 (or more) days before a security release

1. Request the CVE IDs for the security issue(s) being released. One CVE ID per issue, requested with Vendor: djangoproject and Product: django.

2. Generate the relevant (private) patch(es) using git format-patch, one for the main branch and one for each stable branch being patched.

A week before a security release

1. Send out pre-notification exactly one week before the security 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 and be sure to include the relevant CVE IDs. Attach all the relevant patches (targeting main and the stable branches) and sign the email text with the key you’ll use for the release, with a command like:

   $ gpg --clearsign --digest-algo SHA256 prenotification-email.txt
   

2. Notify django-announce of the upcoming security release with a general message such as:

   Notice of upcoming Django security releases (3.2.24, 4.2.10 and 5.0.2)
   
   Django versions 5.0.2, 4.2.10, and 3.2.24 will be released on Tuesday,
   February 6th, 2024 around 1500 UTC. They will fix one security defect
   with severity "moderate".
   
   For details of severity levels, see:
   https://docs.djangoproject.com/en/dev/internals/security/#how-django-discloses-security-issues
   

A few days before any release

1. As the release approaches, watch Trac to make sure no release blockers are left for the upcoming release. Under exceptional circumstances, such as to meet a pre-determined security release date, a release could still go ahead with an open release blocker. The releaser is trusted with the decision to release with an open release blocker or to postpone the release date of a non-security release if required.

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

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

4. Verifique duas vezes as menções de depreciação ao longo do tempo nas notas da release em busca de quaisquer APIs listadas como depreciadas, e que as notas mencionam quaisquer mudanças na versão suportada do Python.

5. Verifique duas vezes se o índice das notas de release possuem um link para as notas da nova release; isso estará em docs/releases/index.txt.

6. 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. This process is a bit lengthy so be sure to set aside 4-10 hours to do this, and ideally plan for this task one or two days ahead of the release day.

   In addition to having a configured Transifex account, the tx CLI should be available in your PATH. Then, you can fetch all the translations by running:

   $ python scripts/manage_translations.py fetch
   

   This command takes some time to run. When done, carefully inspect the output for potential errors and/or warnings. If there are some, you will need to debug and resolve them on a case by case basis.

   The recently fetched translations need some manual adjusting. First of all, the PO-Revision-Date values must be manually bumped to be later than POT-Creation-Date. You can use a command similar to this to bulk update all the .po files (compare the diff against the relevant stable branch):

   $ git diff --name-only stable/5.0.x | grep "\.po"  | xargs sed -ri "s/PO-Revision-Date: [0-9\-]+ /PO-Revision-Date: $(date -I) /g"
   

   All the new .po files should be manually and carefully inspected to avoid committing a change in a file without any new translations. Also, there shouldn’t be any changes in the “plural forms”: if there are any (usually Spanish and French report changes for this) those will need reverting.

   Lastly, commit the changed/added files (both .po and .mo) and create a new PR targeting the stable branch of the corresponding release (example PR updating translations for 4.2).

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

   e então faça commit da página man alterada.

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

9. Escreva o post no blog para o anúncio da release. Você pode entrar dentro do admin a qualquer momento e marcar ele como inativo. Aqui vão alguns exemplos: example security release announcement, example regular release announcement, example pre-release announcement.

A few days before a feature freeze

In preparation for the alpha release, the directory /home/www/www/media/releases/A.B must be created on the djangoproject server.

Before the feature freeze, a branch targeting main must be created to prepare for the next feature release. It should be reviewed and approved a few days before the freeze, allowing it to be merged after the stable branch is cut. The following items should be addressed in this branch:

1. Update the VERSION tuple in django/__init__.py, incrementing to the next expected release (example commit).

2. Create a stub release note for the next feature release. Use the stub from the previous feature release or copy the contents from the current version and delete most of the contents leaving only the headings (example commit).

3. Remove .. versionadded:: and .. versionchanged:: annotations in the documentation from two releases ago, as well as any remaining older annotations. For example, in Django 5.1, notes for 4.2 will be removed (example commit).

4. Remove features that have reached the end of their deprecation cycle, including their docs and the .. deprecated:: annotation. Each removal should be done in a separate commit for clarity. In the commit message, add a Refs #XXXXX -- prefix linking to the original ticket where the deprecation began if possible. Make sure this gets noted in the removed features section in the release notes (example commit).

5. 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 (example commit).

Concrete examples for past feature release bootstrap branches: 5.2 bootstrap, 5.1 bootstrap, 5.0 bootstrap.

Feature freeze tasks

1. Remove empty sections from the release notes (example commit).

2. Build the release notes locally and read them. Make any necessary change to improve flow or fix grammar (example commit).

3. Create a new stable branch from main. For example, when feature freezing Django 5.2:

   $ git checkout -b stable/5.2.x upstream/main
   $ git push upstream -u stable/5.2.x:stable/5.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/5.2.x, set django_next_version to '6.0' on the new stable branch (example commit).

4. Go to the Add release page in the admin, 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 stable/5.2.x, create 5.2 with the Release date field blank. If the release is part of an LTS branch, mark it so.

5. Go to the Add document release page in the admin, create a new DocumentRelease object for the English language for the newly created Release object. Do not mark this as default.

6. Add the new branch to Read the Docs. Since the automatically generated version names (“stable-A.B.x”) differ from the version names used in Read the Docs (“A.B.x”), create a ticket requesting the new version.

7. Request the new classifier on PyPI. For example Framework :: Django :: 5.2.

8. Create a roadmap page for the next release on Trac. To create a new page on the Wiki, navigate to the URL of where you wish to create the page and a “Create this page” button will be available.

9. Update the current branch under active development and add pre-release branch in the Django release process on Trac.

10. Update the docs/fixtures/doc_releases.json JSON fixture for djangoproject.com, so people without access to the production DB can still run an up-to-date copy of the docs site (example PR). This will be merged after the final release.

Lançando a release

OK, this is the fun part, where we actually push out a release! If you’re issuing multiple releases, repeat these steps for each 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, and you should make sure that the latest green run includes the changes that you are releasing.

2. Cleanup the release notes for this release. Make these changes in main and backport to all branches where the release notes for a particular version are located.

   1. For a feature release, remove the UNDER DEVELOPMENT header at the top of the release notes, remove the Expected prefix and update the release date, if necessary (example commit).

   2. For a patch release, remove the Expected prefix and update the release date for all releases, if necessary (example commit).

3. A release always begins from a release branch, so you should make sure you’re on an up-to-date stable branch. Also, you should have available a clean and dedicated virtual environment per version being released. For example:

   $ git checkout stable/4.1.x
   $ git pull
   

4. 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).

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 (example commit).

   1. If this is a pre-release package also update the “Development Status” trove classifier in pyproject.toml to reflect this. An rc pre-release should not change the trove classifier (example commit for alpha release, example commit for beta release).

   2. Otherwise, make sure the classifier is set to Development Status :: 5 - Production/Stable.

Building the artifacts

Optionally use helper scripts

You can streamline some of the steps below using helper scripts from the Wiki:

• Release script

• Test new version script

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

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

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

2. Certifique-se de que você tem uma árvore absolutamente limpa rodando o comando git clean -dfx`.

3. Run python -m build to generate the release packages. This will create the release artifacts (tarball and wheel) in a dist/ directory. For Django 5.0 or older, you need to run make -f extras/Makefile instead.

4. Generate the hashes of the release packages:

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

5. 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 manager’s GitHub username, 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
   
   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/download/<<VERSION>>/tarball/
   https://www.djangoproject.com/download/<<VERSION>>/wheel/
   
   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>>
   

6. Assine o arquivo de checksum (gpg --clearsign --digest-algo SHA256 Django-<version>.checksum.txt). Isso gera um documento assinado, Django-<version>.checksum.txt.asc que você pode então verificar usando gpg --verify Django-<version>.checksum.txt.asc.

Fazendo a release (ou as releases) disponível ao público

Agora você está pronto para lançar a release efetivamente. Para isso faça:

1. Create a new Release entry in the djangoproject.com’s admin. If this is a security release, this should be done 15 minutes before the announced release time, no sooner:

   Versão

   Must match the version number as defined in the tarball (django-<version>.tar.gz). For example: “5.2”, “4.1.1”, or “4.2rc1”.

   Is active

   Set to False until the release is fully published (last step).

   LTS

   Enable if the release is part of an LTS branch.

   Dates

   Set the release date to today. This release will not be published until is_active is enabled.

   Artifacts

   Upload the tarball (django-<version>.tar.gz), wheel (django-<version>-py3-none-any.whl), and checksum (django-<version>.checksum.txt.asc) files created earlier.

2. Test that the release packages install correctly using pip. Here’s one simple method (this just tests that the binaries are available, that they install correctly, and that migrations and the development server start, but it’ll catch silly mistakes): https://code.djangoproject.com/wiki/ReleaseTestNewVersion.

3. Run the confirm-release build on Jenkins to verify the checksum file(s) (e.g. use 4.2rc1 for https://media.djangoproject.com/pgp/Django-4.2rc1.checksum.txt).

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

   $ twine upload --repository django dist/*
   

5. Update the newly created Release in the admin in djangoproject.com and enable the is_active flag.

6. Push your work and the new tag:

   $ git push
   $ git push --tags
   

7. Faça um post no blog anunciando que a release foi lançada.

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 the result generated from running the command manage_translations.py robots_txt in the current stable branch from 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 mailing list 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 [e-mail]. 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.

Pós-release

Você quase terminou! Tudo que resta a fazer agora é:

1. If this is not a pre-release, update the VERSION tuple in django/__init__.py again, incrementing to whatever the next expected release will be. For example, after releasing 4.1.1, update VERSION to VERSION = (4, 1, 2, 'alpha', 0) (example commit).

2. Add the release in Trac’s versions list if necessary (and make it the default by changing the default_version setting in the code.djangoproject.com’s trac.ini, if it’s a final release). The new X.Y version should be added after the alpha release and the default version should be updated after “dot zero” release.

3. If this was a final release:

   1. Update the current stable branch and remove the pre-release branch in the Django release process on Trac.

   2. Update djangoproject.com’s download page (example PR).

4. Se essa for uma release de segurança, atualize Archive of security issues com detalhes dos problemas endereçados.

5. If this was a pre-release, the translation catalogs need to be updated:

   1. Make a new branch from the recently released stable branch:

      git checkout stable/A.B.x
      git checkout -b update-translations-catalog-A.B.x
      

   2. Ensure that the release’s dedicated virtual environment is enabled and run the following:

      $ cd django
      $ django-admin makemessages -l en --domain=djangojs --domain=django
      processing locale en
      

   3. Review the diff before pushing and avoid committing changes to the .po files without any new translations (example commit).

   4. Make a pull request against the corresponding stable branch and merge once approved.

   5. Forward port the updated source translations to the main branch (example commit).

6. If this was an rc pre-release, call for translations for the upcoming release in the Django Forum - Internationalization category.

Considerações quanto a configuração da tupla VERSION

O reporte de versões do Django é controlado por uma tupla VERSION em django/__init__.py. Essa é uma tupla de cinco elementos, cujos elementos são:

1. Versão principal.

2. Versão secundária.

3. Micro versão.

4. Status – pode ser “alpha”, “beta”, “rc” ou “final”.

5. Número das séries, para alpha/beta/RC packages que rodam em sequência (permitindo, por exemplo, “beta 1”, “beta 2”, etc.).

Para uma release final, o status é sempre “final” e o número das séries é sempre 0. Um número de séries 0 com um status “alpha” será reportado como “pre-alpha”.

Alguns exemplos:

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