このドキュメントでは、Django のリリース方法について説明しています。
\nこれらの手順を変更した場合は、最新の情報を保ってください！ ここでのポイントは、規定を設けるのではなく、説明的であることです。自由に効率化したり、変更したりしても構いませんが、 このドキュメントをそれに応じて更新してください！
\nThere are three types of releases that you might need to make:
\nSecurity releases: disclosing and fixing a vulnerability. This'll\ngenerally involve two or three simultaneous releases -- e.g.\n3.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\nbugfix update (e.g. 4.1.1).
Pre-releases: e.g. 4.2 alpha, beta, or rc.
The short version of the steps involved is:
\nIf this is a security release, pre-notify the security distribution list\none week before the actual release.
Proofread the release notes, looking for organization and writing errors.\nDraft a blog post and email announcement.
Update version numbers and create the release artifacts.
Create the new Release in the admin on djangoproject.com.
Set the proper date but ensure the flag is_active is disabled.
Upload the artifacts (tarball, wheel, and checksums).
Verify package(s) signatures, check if they can be installed, and ensure\nminimal functionality.
Upload the new version(s) to PyPI.
Enable the is_active flag for each release in the admin on\ndjangoproject.com.
Post the blog entry and send out the email announcements.
Update version numbers post-release in stable branch(es).
Add stub release notes for the next patch release in main and backport.
There are a lot of details, so please read on.
\n\nYou'll need a few things before getting started. If this is your first release,\nyou'll need to coordinate with another releaser to get all these things lined\nup, and write to the Ops mailing list requesting the required access and\npermissions.
\nA Unix environment with these tools installed (in alphabetical order):
\nbash (version 4.0+)
git
GPG
make
man
hashing tools (typically md5sum, sha1sum, and sha256sum on\nLinux, or md5 and shasum on macOS)
python
A GPG key pair. Securely store the private part, and protect it with a\npassphrase. The public part needs to be uploaded to your GitHub account.
\n\nA clean Python virtual environment (Python 3.10+, pip 26.1+) to build\nartifacts.
Access to Django's project on PyPI to\nupload binaries, ideally with extra permissions to yank a release if necessary. Ensure your PyPI account\nonly uses WebAuthn-based authentication factors, not TOTP (one-time codes).\nCreate an API token following the official documentation, and set up your $HOME/.pypirc file\nlike this:
~/.pypirc[distutils]\n index-servers =\n pypi\n django\n\n[pypi]\n username = __token__\n password = # User-scoped or project-scoped token, to set as the default.\n\n[django]\n repository = https://upload.pypi.org/legacy/\n username = __token__\n password = # A project token.\nAccess to Django's project on Transifex, with a Manager role. Generate\nan API Token in the user setting section and set up your\n$HOME/.transifexrc file like this:
~/.transifexrc[https://www.transifex.com]\n rest_hostname = https://rest.api.transifex.com\n token = # API token\nAccess 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\nthe django-announce\nmailing list.
Access to the django-security repo in GitHub. Among other things, this\nprovides access to the pre-notification distribution list (needed for\nsecurity release preparation tasks).
Access to the Django project on Read the Docs.
A few items need to be taken care of before even beginning the release process.\nThis stuff starts about a week before the release; most of it can be done\nany time leading up to the actual release.
\nReserve one CVE ID per security\nissue as follows. (Or, if you lack CNA credentials, email\ncna@djangoproject.com with a request.)
Enable virtual environment with cvelib installed.
Export user information:
\n$ export CVE_USER=<user-email>@djangoproject.com CVE_ORG=DSF\nReserve:
\n$ cve --interactive reserve <quantity>\nGenerate the relevant (private) patch(es) using git format-patch, one\nfor the main branch and one for each stable branch being patched.
Send out pre-notification exactly one week before the security release.\nThe template for that email and a list of the recipients are in the private\ndjango-security GitHub wiki. BCC the pre-notification recipients, and be\nsure to include the relevant CVE IDs. Attach all the relevant patches\n(targeting main and the stable branches), and sign the email text with\nthe key you'll use for the release, with a command like:
$ gpg --clearsign --digest-algo SHA256 prenotification-email.txt\nNotify django-announce of the upcoming\nsecurity release with a general message such as:
\nNotice of upcoming Django security releases (3.2.24, 4.2.10 and 5.0.2)\n\nDjango versions 5.0.2, 4.2.10, and 3.2.24 will be released on Tuesday,\nFebruary 6th, 2024 around 1500 UTC. They will fix one security defect\nwith severity "moderate".\n\nFor details of severity levels, see:\nhttps://docs.djangoproject.com/en/dev/internals/security/#how-django-discloses-security-issues\nPrepare issue metadata:\n* Severity\n* Short description\n* Reporter\n* Remediator\n* Reported at\n* Confirmed at (usually date CVE reserved)\n* CWE Problem Type\n* CAPEC Impact Type\n* CVSS (4.0) Score & Vector
As the release approaches, watch Trac to make sure no release blockers are\nleft for the upcoming release. Under exceptional circumstances, such as to\nmeet a pre-determined security release date, a release could still go ahead\nwith an open release blocker. The releaser is trusted with the decision to\nrelease with an open release blocker or to postpone the release date of a\nnon-security release if required.
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\nhave been integrated.
\nIn addition to having a configured Transifex account, ensure that the tx\nCLI is available in your\nPATH. You can then fetch all translations since a given date by running:
$ python scripts/manage_translations.py fetch -v 1 --since=<some date>\nTo determine a good value for --since, check the date of the most recent\ncommit with wording similar to Updated translations from Transifex and\nuse a date a few days prior.
This command takes some time to run. When done, carefully inspect the output\nfor potential errors and/or warnings. If there are some, you will need to\ndebug and resolve them on a case by case basis.
\nThe recently fetched translations need some manual adjusting. First of all,\nthe PO-Revision-Date values must be manually bumped to be later than\nPOT-Creation-Date. You can use a command similar to this to bulk update\nall 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"\nLastly, commit the changed/added files (both .po and .mo) and create\na new PR targeting the stable branch of the corresponding release (example\nPR updating translations for 4.2).
Once merged, forward port the changes into main (example commit).
Update the django-admin manual page:
\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\nand then commit the changed man page.
\nIf 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 4.2:
\n$ git checkout -b stable/4.2.x origin/stable/4.1.x\n$ git push origin stable/4.2.x:stable/4.2.x\nWrite the announcement blog post for the release. You can enter it into the\nadmin at any time and mark it as inactive. Here are a few examples: example\nsecurity release announcement, example regular release announcement,\nexample pre-release announcement.
In preparation for the alpha release, the directory\n/home/www/www/media/releases/A.B must be created on the djangoproject\nserver.
Before the feature freeze, a branch targeting main must be created to\nprepare for the next feature release. It should be reviewed and approved a few\ndays before the freeze, allowing it to be merged after the stable branch is\ncut. The following items should be addressed in this branch:
Update the VERSION tuple in django/__init__.py, incrementing to the\nnext expected release (example commit).
Create a stub release note for the next feature release. Use the stub from\nthe previous feature release or copy the contents from the current version\nand delete most of the contents leaving only the headings\n(example commit).
Remove .. versionadded:: and .. versionchanged:: annotations in the\ndocumentation from two releases ago, as well as any remaining older\nannotations. For example, in Django 5.1, notes for 4.2 will be removed\n(example commit).
Remove features that have reached the end of their deprecation cycle,\nincluding their docs and the .. deprecated:: annotation. Each removal\nshould be done in a separate commit for clarity. In the commit message, add\na Refs #XXXXX -- prefix linking to the original ticket where the\ndeprecation began if possible. Make sure this gets noted in the removed\nfeatures section in the release notes (example commit).
Advance the deprecation warnings (example commit).
Increase the default PBKDF2 iterations in\ndjango.contrib.auth.hashers.PBKDF2PasswordHasher by about 20%\n(pick a round number). Run the tests, and update the 3 failing\nhasher tests with the new values. Make sure this gets noted in the\nrelease notes (example commit).
Concrete examples for past feature release bootstrap branches: 5.2 bootstrap, 5.1 bootstrap, 5.0 bootstrap.
\nRemove empty sections from the release notes (example commit).
Build the release notes locally and read them. Make any necessary change\nto improve flow or fix grammar (example commit).
Create a new stable branch from main. Be sure to fetch and update\nupstream to latest. For example, when feature freezing Django 5.2:
$ git fetch upstream\n$ git checkout -b stable/5.2.x upstream/main\n$ git push upstream -u stable/5.2.x:stable/5.2.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/5.2.x, set\ndjango_next_version to '6.0' on the new stable branch\n(example commit).
Create Release entries for the next version in the admin on\ndjangoproject.com. Add one for each milestone (alpha, beta, rc, and\nfinal), leaving is active unset to mark them as unreleased. Set target\ndates per the agreed schedule, and set the LTS flag if applicable. The\nX.Y roadmap page will be available at /download/X.Y/roadmap/.
For example, when creating stable/5.2.x, add Release entries for\n6.0a1, 6.0b1, 6.0rc1, and 6.0. The 6.0 roadmap can be\nthen reviewed at https://www.djangoproject.com/download/6.0/roadmap/.
Go to the Add document release page in the admin, create a new\nDocumentRelease object for the English language for the newly created\nRelease object. Do not mark this as default.
Add the new branch to Read the Docs. Since the automatically\ngenerated version names ("stable-A.B.x") differ from the version names used\nin Read the Docs ("A.B.x"), update the Read the Docs config for the version\nto point to the slug A.B.x and set it as active. See more details.
Create a PR on PyPI proposing the new Trove classifier.\nFor example Framework :: Django :: 5.2.
Update the current branch under active development and add pre-release\nbranch in the Django release process on Trac.
Update the docs/fixtures/doc_releases.json JSON fixture for\ndjangoproject.com, so people without access to the production DB can still\nrun an up-to-date copy of the docs site\n(example PR).\nThis will be merged after the final release.
OK, this is the fun part, where we actually push out a release! If you're\nissuing multiple releases, repeat these steps for each release.
\nCheck Jenkins is green for the version(s) you're putting out. You\nprobably shouldn't issue a release until it's green, and you should make\nsure that the latest green run includes the changes that you are releasing.
\nCleanup the release notes for this release. Make these changes in main\nand backport to all branches where the release notes for a particular\nversion are located.
For a feature release, remove the UNDER DEVELOPMENT header at the top\nof the release notes, remove the Expected prefix and update the\nrelease date, if necessary (example commit).
For a patch release, remove the Expected prefix and update the\nrelease date for all releases, if necessary (example commit).
Regenerate a fresh, dedicated virtual environment for the release tools\nusing a cooldown:
\n$ python -m pip install build twine --uploaded-prior-to=P7D\nA release always begins from a release branch, so you should make sure\nyou're on an up-to-date stable branch. For example:
\n$ git checkout stable/4.1.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/4.1.x\n$ git merge --ff-only security/4.1.x\n(This assumes security/4.1.x is a branch in the django-security repo\ncontaining the necessary security patches for the next release in the 4.1\nseries.)
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/4.1.x; git rebase stable/4.1.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).
Update the version number in django/__init__.py for the release.\nPlease see notes on setting the VERSION tuple below for details\non VERSION (example commit).
If this is a pre-release package also update the "Development Status"\ntrove classifier in pyproject.toml to reflect this. An rc\npre-release should not change the trove classifier (example\ncommit for alpha release,\nexample commit for beta release).
Otherwise, make sure the classifier is set to\nDevelopment Status :: 5 - Production/Stable.
Tag the release using git tag. For example:
$ git tag --sign --message="Tag 4.1.1" 4.1.1\nYou can check your work running git tag --verify <tag>.
Make sure you have an absolutely clean tree by running git clean -dfx.
Run python -m build to generate the release packages. This will create\nthe release artifacts (tarball and wheel) in a dist/ directory.
Generate the hashes of the release packages:
\n$ cd dist\n$ md5sum *\n$ sha1sum *\n$ sha256sum *\nCreate a "checksums" file, Django-<<VERSION>>.checksum.txt containing\nthe hashes and release information. Start with this template and insert the\ncorrect version, date, GPG key ID (from\ngpg --list-keys --keyid-format LONG), release manager's GitHub username,\nrelease URL, and checksums:
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 GitHub, for example,\nif using the open-source GNU Privacy Guard implementation of PGP:\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/download/<<VERSION>>/tarball/\nhttps://www.djangoproject.com/download/<<VERSION>>/wheel/\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>>\nSign the checksum file (gpg --clearsign --digest-algo SHA256\nDjango-<version>.checksum.txt). This generates a signed document,\nDjango-<version>.checksum.txt.asc which you can then verify using gpg\n--verify Django-<version>.checksum.txt.asc.
Now you're ready to actually put the release out there. To do this:
\nCreate a new Release entry in the djangoproject.com's admin. If this is a\nsecurity release, this should be done 15 minutes before the announced\nrelease time, no sooner:
Must match the version number as defined in the tarball\n(django-<version>.tar.gz). For example: "5.2", "4.1.1", or "4.2rc1".
Set to False until the release is fully published (last step).
\nEnable if the release is part of an LTS\nbranch.
\nSet the release date to today. This release will not be published until\nis_active is enabled.
Upload the tarball (django-<version>.tar.gz), wheel\n(django-<version>-py3-none-any.whl), and checksum\n(django-<version>.checksum.txt.asc) files created earlier.
Test that the release packages install correctly using pip. Here's one\nsimple method (this just tests that the binaries are available, that they\ninstall correctly, and that migrations and the development server start, but\nit'll catch silly mistakes):\nhttps://code.djangoproject.com/wiki/ReleaseTestNewVersion.
Run the confirm-release build on Jenkins to verify the checksum file(s)\n(e.g. use 4.2rc1 for\nhttps://media.djangoproject.com/pgp/Django-4.2rc1.checksum.txt).
Generate a new token for this release on PyPI, and store it in .pypirc\nas shown above.
Upload the release packages to PyPI:
\n$ twine upload --repository django dist/*\nOn PyPI, revoke the token you just created.
Update the newly created Release in the admin in djangoproject.com\nand enable the is_active flag.
Push your work and the new tag:
\n$ git push\n$ git push --tags\nMake the blog post announcing the release live.
For a new version release (e.g. 4.1, 4.2), 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 the result generated from running the command\nmanage_translations.py robots_txt in the current stable branch from the\ndjango-docs-translations repository. For example, when releasing Django\n4.2:
$ git checkout stable/4.2.x\n$ git pull\n$ python manage_translations.py robots_txt\nPost the release announcement to the django-announce mailing list and the\nDjango Forum. This should include a link to the announcement blog post.
If this is a security release, publish the CVE metadata. (The\nchecklist app generates JSON for this.):
\n$ cve publish <cve-number> --cve-json-file <path-to-file>\nIf this is a security release, send a separate email to\noss-security@lists.openwall.com. Provide "Django" plus the CVE IDs in\nthe subject line. The message body should include the vulnerability details,\nfor example, the announcement blog post text. Include a link to the\nannouncement blog post.
You're almost done! All that's left to do now is:
\nIf this is not a pre-release, update the VERSION tuple in\ndjango/__init__.py again, incrementing to whatever the next expected\nrelease will be. For example, after releasing 4.1.1, update VERSION to\nVERSION = (4, 1, 2, 'alpha', 0) (example commit).
If this was an alpha release:
\nAdd the feature release version in Trac's versions list.
Create a new security branch from the freshly cut stable branch. Be sure\nto fetch and update upstream to latest. For example, after the 5.2\nalpha release:
$ git fetch upstream\n$ git checkout -b security/5.2.x upstream/stable/5.2.x\n$ git push origin -u security/5.2.x:security/5.2.x\nIf this was a final release:
\nUpdate the default_version setting in the code.djangoproject.com's\ntrac.ini file (example PR).
Update the current stable branch and remove the pre-release branch in the\nDjango release process on Trac.
Update djangoproject.com's download page (example PR).
Process the older versions that will reach End-Of-Mainstream and/or\nEnd-Of-Life support when this final release is published:
\nEnsure that the EOL versions are mentioned in the blog post. See\nexample announcement.
Create a tag for the EOL stable branch and delete the stable branch.\nInspect and use the scripts/archive_eol_stable_branches.py helper.
If this was a security release, update セキュリティ上の問題のアーカイブ with\ndetails of the issues addressed.
If this was a pre-release, the translation catalogs need to be updated:
\nMake a new branch from the recently released stable branch:
\n$ git checkout stable/A.B.x\n$ git checkout -b update-translations-catalog-A.B.x\nEnsure that the release's dedicated virtual environment is enabled and\nrun the following:
\n$ cd django\n$ django-admin makemessages -l en --domain=django\nprocessing locale en\n$ django-admin makemessages -l en --domain=djangojs\nprocessing locale en\nMake a pull request against the corresponding stable branch and merge\nonce approved.
Forward port the updated source translations to the main branch\n(example commit).
If this was an alpha pre-release, coordinate with the maintainer of\nasgiref to determine when to raise the minimum version before the\nfinal release. For the backport, add an upper bound on the next major\nversion (example commits:\nmain,\nbackport).
If this was an rc pre-release, call for translations for the upcoming\nrelease in the Django Forum - Internationalization category.
Django's version reporting is controlled by the VERSION tuple in\ndjango/__init__.py. This is a five-element tuple, whose elements\nare:
Major version.
Minor version.
Micro version.
Status -- can be one of "alpha", "beta", "rc" or "final".
Series number, for alpha/beta/RC packages which run in sequence\n(allowing, for example, "beta 1", "beta 2", etc.).
For a final release, the status is always "final" and the series\nnumber is always 0. A series number of 0 with an "alpha" status will\nbe reported as "pre-alpha".
\n例：
\n(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"