Bagaimana Django Dibentuk?

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!

Ikhtisar

Terdapat tiga jenis terbitan yang anda mungkin butuh untuk dibuat:

  • Terbitan keamanan: Membuka dan memperbaiki kerentanan. Ini akan secara umum melibatkan dua atau tiga terbitan berkelanjutan -- sebagai contoh 1.5.x, 1.6.x, dan, tergantung pada pewaktuan, mungkin 1.7 alpha/beta/rc.
  • Terbitan versi reguler: salah satu terbitan akhir (sebagai contoh 1.5) atau pembaharuan perbaikan kesalahan (sebagai contoh 1.5.1).
  • Pra-terbitan: sebagai contoh alpha, beta, atau rc.

Versi pendek dari langkah-langkah bersangkutan adalah:

  1. Jika ini adalah terbitan keamanan, beritahu daftar penyebaran keamanan satu minggu sebelum terbitan sebenarnya.
  2. Proofread catatan terbitan, menacri kesalahan organisasi dan penulisan. Konsep sebuah penempatan blog dan pengumuman surel.
  3. Perbaharui angka versi dan buat paket terbitan.
  4. Unggah paket ke peladen djangoproject.com.
  5. Unggah versi terbaru ke PyPI.
  6. Nyatakan versi baru di admin pada djangoproject.com.
  7. Tempatkan masukan blog dan kirim pengumuman surel.
  8. Perbaharui angka versi pasca-terbitan.

Ada banyak rincian, jadi silahkan lanjutkan membaca.

Prasyarat

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.

  • Sebuah pemasangan dari beberapa membutuhkan paket Python:

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

Tugas-tugas pra terbitan

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:

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

  2. Ketika terbitan mendekat. lihat Trac untuk memastikan tidak ada pemblok terbitan tertinggal untuk terbitan akan datang.

  3. Periksa dengan pembuat perbaikan untuk memastikan mereka tidak mempunyai perubahan belum diperbaiki apapun untuk terbitan.

  4. Proofread catatan terbitan, termasuk mencari versi daring untuk menangkap tiap tautan rusak atau kesalahan reST, dan pastikan catatan terbitan mengandung tanggal benar.

  5. Periksa kembali itu catatan terbitan menyebutkan linimasa pengusangan untuk setiap API dicatat sebagai diusangkan, dan mereka menyebut bahwa tiap perubahan di Python versi dukungan.

  6. Periksa kembali itu catatan terbitan index mempunyai sebuah tautan ke catatan untuk terbitan baru; ini akan ada di docs/releases/index.txt.

  7. Jika ini adalah terbitan fitur, apstikan terjemahan dari Transifex telah dipadukan. Ini adalah khususnya dilakukan oleh pengelola terjemahan terpisah daripada penerbit, tetapi ini adalah langkah-langkah. Disediakan anda mempunyai sebuah akun di Transifex:

    $ python scripts/manage_translations.py fetch

    dan kemudian perbaiki berkas dirubah/ditambahkan (kedua .po dan .mo). Terkadang ada pengecekan kesalahan yang butuh di cari kesalahan, jadi hindari melakukan tugas ini secepatnya sebelum terbitan dibutuhkan.

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

  9. If this is the alpha release of a new series, create a new stable branch from main. For example, when releasing 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.

  10. Jika ini adalah terbitan "dot zero" dari deretan baru, buat sebuah cabang baru dari cabang stabil sekarang dalam gudang django-docs-translations. Sebagai contoh, ketika menerbitkan 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

Bersiap untuk terbitan

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.

Sebenarnya menggulir terbitan

OKE, ini adalah bagian menyenangkan, dimana kami sebenarnya mendorong terbitan!

  1. Periksa Jenkins adalah hijau untuk versi anda hasilkan. Anda mungkin tidak harus mengeluarkan terbitan sampai itu hijau.

  2. Terbitan selalu dimulai dari cabang terbitan, jadi anda harus pastikan anda berada di cabang stabil dan terbaru. Sebagai contoh:

    $ git checkout stable/1.5.x
$ git pull

  3. Jika ini adalah terbitan keamanan, gabungkan tambalan yang sesuai dari django-security. Dasarkan kembali tambalan ini sesuai kebutuhan untuk membuat masing-masing satu commit tawar pada terbitan cabang daripada menggabungkan commit. Untuk memastikan ini, gabungkan mereka dengan bendera --ff-only; sebagai contoh:

    $ git checkout stable/1.5.x
$ git merge --ff-only security/1.5.x

    (Hal ini mengasumsikan security/1.5.x merupakan branch dalam repositori django-security yang mengandung tambalan keamanan untuk rilis berikutnya dalam versi 1.5.)

    Jika git menolak untuk menggabungkan dengan "--ff-only", ganti patch-keamanan dan rebase pada cabang yang akan kamu gabungkan ("git checkout security/1.5x; git rebase stable/1.5.x") kemudian pindah lagi dan lakukan penggabungan. Pastikan pesan perubahan adalah sebuah perbaikan keamanan dan pemberitahuan tersebut akan mengikuti(: commit: 'example security commit <bf39978a53f117ca02e9a0c78b76664a41a54745>).

  4. Untuk terbitan selanjutnya, pindahkan kepala UNDER DEVELOPMENT pada atas catatan terbitan dan tambahkan tanggal terbitan pada baris selanjutnya. Untuk terbitan tambalan, ganti *Under Development* dengan tanggal terbitan. Buat perubahan ini pada semua cabang-cabang dimana catatan terbitan untuk versi khusus ditempatkan.

  5. Perbaharui angka versi di django/__init__.py untuk terbitan. Silahkan lihat notes on setting the VERSION tuple dibawah ini untuk rincian pada VERSION.

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

  7. Etiket diterbitkan menggunakan etiket git. Sebagai contoh:

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

    Anda dapat memeriksa pekerjaan anda dengan menjalankan git tag --verify <tag>.

  8. Dorong pekerjaan anda, termasuk etiket: git push --tags.

  9. Pastikan anda mempunyai pohon sepenuhnya bersih dengan menjalankan git clean -dfx.

  10. Jalankan make -f extras/Makefile untuk membangkitkan paket terbitan. Ini akan membuat paket terbitan di direktori dist/.

  11. Membangkitkan has dari paket terbitan:

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

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

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

Membuat terbitan tesedia ke umum

Sekarang anda siap benar-benar menaruh terbitan diluar sana. Untuk melakukan ini:

  1. Unggah paket-paket terbitan ke peladen djangoproject, ganti A.B. dengan angka versi yang sesuai, sebagai contoh 1.5 untuk terbitan 1.5.x:

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

  2. Unggah berkas checksum:

    $ scp Django-A.B.C.checksum.txt.asc djangoproject.com:/home/www/www/media/pgp/Django-A.B.C.checksum.txt

  3. Test that the release packages install correctly using easy_install and pip. Here's one method:

    $ RELEASE_VERSION='1.7.2'
$ MAJOR_VERSION=`echo $RELEASE_VERSION| cut -c 1-3`

$ python -m venv django-easy-install
$ . django-easy-install/bin/activate
$ easy_install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz
$ deactivate
$ 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.

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

  5. Unggah paket-paket terbitan ke PyPI (untuk pra-terbitan, hanya perbaharui berkas wheel):

    $ twine upload -s dist/*

  6. Pergi ke Add release page in the admin, masukkan angka terbitan baru tepat ketika itu muncul dalam nama dari tarball (Django-<version>.tar.gz). Jadi sebagai contoh "1.5.1" atau "1.4c2", dll. Jika terbitan adalah bagian dari cabang LTS, tandai dia.

    Jika ini adalah terbitan alfa dari deretan baru, juga bua sebuah objek Release untuk terbitan*akhir*, pastikan bahwa bidang Release date adalah kosong, dengan demikian tandai itu sebagai unreleased. Sebagai contoh, ketika membuat objek Release untuk 3.1a1, juga membuat 3.1 dengan bidang tanggal Release kosong.

  7. Buat blog menempatkan pengumuman terbitan langsung.

  8. Untuk terbitan versi baru (sebagai coontoh 1.5, 1.6), perbaharui versi stabil awal dari dokumen dengan membalikkan bendera is_default menjadi True pada obyek DocumentRelease yang sesuai di basisdata docs.djangoproject.com (ini akan otomatis menggantinya menjadi False untuk semua lainnya); anda dapat melakukan ini menggunakan admin situs.

    Buat objek baru DocumentRelease untuk setiap bahasa yang mempunyai sebuah masukan untuk terbitan sebelumnya. Perbaharui berkas djangoproject.com's robots.docs.txt dengan menyalin masukan manage_translations.py robots_txt dari cabang stabil sekarang dalam gudang django-docs-translations. Sebagai contoh, ketika menerbitkan Django 2.2:

    $ git checkout stable/2.2.x
$ git pull
$ python manage_translations.py robots_txt

  9. Tempatkan pengumuman terbitan pada daftar penyuratan django-announce, django-developers, dan django-users. Ini harus menyertakan sebuah tautan ke penempatan blog pengumuman.

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

  11. Add a link to the blog post in the topic of the #django IRC channel: /msg chanserv TOPIC #django new topic goes here.

Pasca-terbitan

Anda hampir selesai! Semua yang tersisa untuk dilakukan sekarang adalah:

  1. Perbaharui tuple VERSION di django/__init__.py lagi, naikkan ke apapun terbitan selanjutnya yang akan diharapkan. Sebagai contoh, setelah menerbitkan 1.5.1, perbaharui VERSION ke VERSION = (1, 5, 2, 'alpha', 0).
  2. Tambahkan terbitan dalam Trac's versions list jika dibutuhkan (dan buat sebagai awalan dengan merubah pengaturan 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".
  3. Jika ini adalah terbitan keamanan, perbaharui Arsip dari masalah keamanan dengan rincian dari masalah-masalah yang dialamatkan.

Tugas cabang stabil baru

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.

  1. Buat sebuah obyek 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.
  2. Buat sebuah catatan terbitan rintisan untuk versi fitur baru. Gunakan rintisan dari terbitan fitur sebelumnya atau salin isi dari versi fitur sebelumnya dan hapus kebanyakan isi meninggalkan hanya kepala.
  3. Tingkatkan perulangan PBKDF2 awal di django.contrib.auth.hashers.PBKDF2PasswordHasher sekitar 20% (ambil angka bulat). Jalankan percobaan, dan perbaharui 3 kegagalan percobaan hash dengan nilai baru. Pastikan ini mendapatkan catatan di catatan terbitan (lihat catatan terbitan 1.8 untuk sebuah contoh).
  4. Pindahkan fitur yang telah mencapai akhir dari siklus pengusangannya. Setiap perpindahan harus selesai di perbaikan terpisah untuk kejelasan. Dalam pesan perbaikan, tambah "refs #XXXX" pada tiket asli dimana pengusangan dimulai jika memungkinkan.
  5. Pindahkan keterangan .. versionadded::, .. versionadded::, dan .. deprecated:: di dokumentasi dari dua terbitan lampau. Sebagai contoh, di Django 1.9, catatan untuk 1.7 akan dipindahkan.
  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 :: 3.1.

Catatan pada pengaturan tuple VERSION

Pelaporan versi Django dikendalikan oleh tuple VERSION di django/__init__.py. Ini adalah lima-unsur tuple, yang unsurnya adalah:

  1. Versi utama.
  2. Versi kecil.
  3. Versi mikro.
  4. Keadaan -- dapat menjadi satu dari "alpha", "beta", "rc" atau "final".
  5. Rangkaian angka, untuk paket alpha/beta/RC yang berjalan dalam urutan (mengizinkan, sebagai contoh, "beta 1", "beta 2", etc.).

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:

  • (1, 2, 1, 'final', 0) → "1.2.1"
  • (1, 3, 0, 'alpha', 0)` → "1.3 pra-alpha"
  • (1, 3, 0, 'beta', 2) → "1.3 beta 2"
Back to Top