Dokumen ini menjelaskan bagaimana menerbitkan Django.
Harap, jaga petunjuk-petunjuk ini terbaru jika anda membuat perubahan! Titiknya disini adalah menjadi lebih menggambarkan, bukan memberi petunjuk, jadi silahkan untuk mempersingkat atau jika tidak buat perubahan, tetapi perbaharui dokumen ini sesuai dengan itu!
Terdapat tiga jenis terbitan yang anda mungkin butuh untuk dibuat:
Versi pendek dari langkah-langkah bersangkutan adalah:
djangoproject.com
.djangoproject.com
.Ada banyak rincian, jadi silahkan lanjutkan membaca.
Anda akan butuh beberapa hal sebelum memulai:
Kunci GPG. Jika kunci anda ingin gunakan bukan kunci tandantangan awal anda, anda akan butuh menambahkan -u you@example.com` ke setiap perintah tandatangan GPG dibawah, dimana you@example.com
adalah alamat surel terhubung dengan kunci anda ingin gunakan.
An install of some required Python packages:
$ python -m pip install wheel twine
Akses ke rekaman Django pada PyPI. Buat sebuah berkas dengan mandat anda:
~/.pypirc
¶[pypi]
username:YourUsername
password:YourPassword
Akses pada peladen djangoproject.com
untuk mengunggah berkas.
Akses pada admin di djangoproject.com
sebagai "Perawat situs".
Akses untuk menempatkan ke django-announce
.
Jika ini adalah terbitan keamanan, akses ke pemberitahuan daftar penyebaran.
Jika ini adalah terbitan pertama anda, anda akan butuh berhubungan dengan penerbit lain untuk mendapatkan semua hal ini berbaris.
Beberapa barang harus dijaga sebelum bahkan memulai pengolahan terbitan. Barang ini mulai sekitar seminggu sebelum terbitan; kebanyakan dari itu dapat dilakukan kapan saja membawa ke terbitan sebenarnya:
Ini adalah terbitan keamanan, mengirimkan pra-pemberitahuan satu minggu sebelum terbitan. Cetakan untuk surel itu dan daftar dari penerima adalah dalam wiki GitHub django-security
pribadi. Penerima BCC pra-pemberitahuan. Menandai surel dengan kunci anda akan gunakan untuk terbitan dan menyertakan CVE IDs (diminta dengan Vendor: djangoproject, Product: django) dan tambalan untuk setiap masalah yang sedang diperbaiki. Juga, notify django-announce of the upcoming security release.
Ketika terbitan mendekat. lihat Trac untuk memastikan tidak ada pemblok terbitan tertinggal untuk terbitan akan datang.
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.
Periksa kembali itu catatan terbitan menyebutkan linimasa pengusangan untuk setiap API dicatat sebagai diusangkan, dan mereka menyebut bahwa tiap perubahan di Python versi dukungan.
Periksa kembali itu catatan terbitan index mempunyai sebuah tautan ke catatan untuk terbitan baru; ini akan ada di 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.
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
dan kemudian perbaiki perubahan halaman panduan.
If this is the alpha release of a new series, create a new stable branch from main. For example, when releasing 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.
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
Tulis penempatan blog pengumuman untuk terbitan. Anda dapat memasukkannya kedalam admin kapan pun dan menandainya sebagai tidak aktif. Ini adalah beberapa contoh: example security release announcement, example regular release announcement, example pre-release announcement.
OKE, ini adalah bagian menyenangkan, dimana kami sebenarnya mendorong terbitan!
Periksa Jenkins adalah hijau untuk versi anda hasilkan. Anda mungkin tidak harus mengeluarkan terbitan sampai itu hijau.
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
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).
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.
Perbaharui angka versi di django/__init__.py
untuk terbitan. Silahkan lihat notes on setting the VERSION tuple dibawah ini untuk rincian pada 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 4.1.1" 4.1.1
Anda dapat memeriksa pekerjaan anda dengan menjalankan git tag --verify <tag>
.
Dorong pekerjaan anda, termasuk etiket: git push --tags
.
Pastikan anda mempunyai pohon sepenuhnya bersih dengan menjalankan git clean -dfx
.
Jalankan make -f extras/Makefile
untuk membangkitkan paket terbitan. Ini akan membuat paket terbitan di direktori dist/
.
Generate the hashes of the release packages:
$ cd dist
$ md5sum *
$ sha1sum *
$ sha256sum *
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/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>>
Tandatangi berkas checksum (gpg --clearsign --digest-algo SHA256 Django-<version>.checksum.txt
). Ini membangkitkan dokumen ditandatangi, Django-<version>.checksum.txt.asc
yang anda dapat kemudian memeriksa menggunakan gpg --verify Django-<version>.checksum.txt.asc
.
Jika anda sedang menerbitkan banyak terbitan, ulangi langkah ini untuk setiap terbitan.
Sekarang anda siap benar-benar menaruh terbitan diluar sana. Untuk melakukan ini:
Upload the release package(s) to the djangoproject server, replacing A.B. with the appropriate version number, e.g. 4.1 for a 4.1.x release:
$ scp Django-* djangoproject.com:/home/www/www/media/releases/A.B
Jika ini adalah terbitan alfa dari deretan baru, anda akan butuh membuat direktori A.B.
Upload the checksum file(s):
$ 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='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
Ini hanya percobaan dimana tarball tersedia (yaitu pengalihan hidup) dan dimana mereka memasang dengan benar, tetapi dia akan menangkap kesalahan-kesalahan bodoh.
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).
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 "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.
Buat blog menempatkan pengumuman terbitan langsung.
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
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.
Jika ini adalah terbitan keamanan, kirim surel terpisah ke oss-security@lists.openwall.com. Sediakan gambaran subjek, sebagai contoh, "Django" ditambah masalah dari catatan terbitan (termasuk ID CVE). Badan pesan harus menyertakan rincian kerentanan, sebagai contoh, pengumuman teks penempatan blog. Sertakan sebauh tautan pada penempatan blog pengumuman
Add a link to the blog post in the topic of the #django
IRC channel:
/msg chanserv TOPIC #django new topic goes here
.
Anda hampir selesai! Semua yang tersisa untuk dilakukan sekarang adalah:
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)
.default_version
dalam code.djangoproject.com's trac.ini, jika terbitan akhirnya). Versi X.Y baru harus ditambahkan setelah terbitan alfa dan versi awalan harus diperbaharui setelah terbitan "dot zero".Ada beberapa barang untuk dilakukan di waktu mengikuti pembuatan cabang stabil baru (sering mengikuti terbitan alpha). Beberapa dari pekerjaan ini tidak butuh diselesaikan oleh penerbit.
DocumentRelease
baru di basisdata docs.djangoproject.com
untuk dokumen versi baru, dan perbaharui docs/fixtures/doc_releases.json
perlengkapan lengkap JSON, jadi orang tanpa akses ke BD produksi dapat masih menjalankan salinan terbaru dari situs dokumentasi.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 (see the 4.1 release notes for an example)... versionadded::
, .. versionadded::
, and .. deprecated::
annotations in the documentation from two releases ago. For example, in
Django 4.2, notes for 4.0 will be removed.Framework :: Django :: 3.1
.Pelaporan versi Django dikendalikan oleh tuple VERSION
di django/__init__.py
. Ini adalah lima-unsur tuple, yang unsurnya adalah:
Untuk terbitan akhir, keadaan selalu "final" dan rangkaian angka selalu 0. Rangkaian angka dari 0 dengan keadaan "alpha" akan dilaporkan sebagai "pre-alpha".
Beberapa contoh:
(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"Des 04, 2023