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:

    $ 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 berkoordinasi dengan James dan/atau Jacob untuk mendapatkan semua hal ini diantrikan.

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. Jika ini adalah sebuah terbitan keamanan, kirimkan pemberitahuan satu minggu sebelum terbitan. Kami merawat daftar dari siapa yang mendapatkan surel pemberitahuan dalam gudang django-core pribadi. Kirim surel ke security@djangoproject.com dan BCC penerima pemberitahuan. Surel ini harus ditandatangani oleh kunci anda akan gunakan untuk terbitan dan harus menyertakan CVE IDs (diminta dengan Vendor: djangoproject, Product: django) dan tambalan-tambalan untuk setiap masalah sedang diperbaiki. Juga, notify django-announce dari terbitan keamanan akan datang.

  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.

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, gabung tambalan yang sesuai dari django-private. Rebase tambalan ini seperlunya untuk membuat tiap satu perbaikan sederhana pada cabang terbitan daripada menggabungkan perbaikan. 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
    

    (Ini menganggap security/1.5.x adalah cabang di gudang django-private megnandung tambalan keamanan yang dibutuhkan untuk terbitan selanjutnya di rangkaian 1.5.)

    Jika git menolah menggabungkan dengan --ff-only, pindah ke cabang tambalan-keamanan dan rebase dia di cabang anda akan gabungkan dia kedalam (git checkout security/1.5.x; git rebase stable/1.5.x) dan kemudain pindah kembali dan lakukan penggabungan. Pastikan pesan perbaikan untuk setiap perbaikan keamanan menjelasakan bahwa perbaikan adalah perbaikan keamanan dan bahwa sebuah pengumuman akan mengikuti (example security commit).

  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. Jika ini adalah paket pra terbitan, perbaharui penggolong koleksi "Keadaan Pengembangan" dalam setup.py untuk mencerminkan ini. Jika tidak, pastikan penggolong disetel ke 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. Buat sebuah berkas "checksums", Django-<<VERSION>>.checksum.txt mengandung informasi has dan terbitan. Mulai dengan cetakan ini dan masukkan versi benar, tanggal, ID kunci GPG (dari gpg --list-keys --keyid-format LONG), URL terbitan, dan checksum:

    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
    
    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
    
  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. Uji yang paket terbitan dipasang dengan benar menggunakan easy_install dan pip. Ini adalah satu cara (yang membutuhkan virtualenvwrapper):

    $ RELEASE_VERSION='1.7.2'
    $ MAJOR_VERSION=`echo $RELEASE_VERSION| cut -c 1-3`
    
    $ mktmpenv
    $ easy_install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz
    $ deactivate
    $ mktmpenv
    $ pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz
    $ deactivate
    $ mktmpenv
    $ 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. Tanyakan sedikit orang di IRC untuk memeriksa checksum dengan mengunjungi berkas checksum (sebagai contoh https://www.djangoproject.com/m/pgp/Django-1.5b1.checksum.txt) dan mengikuti perintah di dalamnya. Untuk titik bonus, mereka dapat juga membuka tarball terbitan terunduh dan periksa bahwa isinya benar (angka versi tepat, tidak menyimpang .pyc atau berkas-berkas yang tidak diinginkan lainnya).

  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.

  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.

    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 the previous release.

  9. Tempatkan pengumuman terbitan ke daftar penyuratan django-announce, django-developers, dan django-users. Ini harus menyertakan sebuah tautan ke penempatan pengumuman blog. Jika ini adalah terbitan keamanan, juga sertakan oss-security@lists.openwall.com.

  10. Tambah sebuah tautan pada penempatan blog di topik dari #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. Tambah terbitan dalam Trac's versions list jika dibutuhkan (dan buat kan awalnya jika itu adalah terbitan akhir). Tidak semua versi dinyatakan; ambil contoh pada terbitan sebelumnya.
  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. Tambah cabang baru ke Read the Docs. Sejak nama versi dibangkitkan otomatis ("stable-A.B.x") berbeda dari angka versi kami telah gunakan menurut sejarah di Read the Docs ("A.B.x"), kami saat ini meminta Eric Holscher menambahkan versi untuk kami. Suatu waktu nama lain fungsionalitas mungkin dipasang tetap ke Read the Docs UI.

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