How to release DjangoLink to this heading#

ForbhreathnúLink to this heading#

Tá trí chineál eisiúintí ann a d'fhéadfadh go mbeadh ort a dhéanamh:

• Scaoiltí slándála: leochaileacht a nochtadh agus a shocrú De ghnáth beidh dhá nó trí eisiúint chomhuaineach i gceist leis seo - m.sh. 3.2.x, 4.0.x, agus, ag brath ar an uainiú, b'fhéidir 4.1.x.

• Eisiúintí leagan rialta: scaoileadh deiridh (m.sh. 4.1) nó nuashonrú bugfix (m.sh. 4.1.1).

• Réamh-eisiúintí: m.sh. 4.2 alfa, béite, nó rc.

Is é an leagan gairid de na céimeanna atá i gceist ná:

1. Más scaoileadh slándála é seo, déan an liosta dáilte slándála réamh-fógra seachtain roimh an eisiúint iarbhír.

2. Cruthléigh na nótaí scaoilte, ag lorg earráidí eagraíochta agus scríbhneoireachta. Blagphost agus fógra ríomhphoist a dhréachtú.

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. Fíoraigh sínithe pacáiste/na pacáistí, seiceáil an féidir iad a shuiteáil, agus cinntigh íosta feidhmiúlacht.

6. Uaslódáil an leagan/na leaganacha nua chuig PyPi.

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

8. Postáil iontráil an bhlag agus seol amach na fógraí ríomhphoist.

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

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

Tá go leor sonraí ann, mar sin léigh ar aghaidh le do thoil.

RiachtanaisLink to this heading#

Beidh cúpla rud ag teastáil uait sula dtosaíonn tú. Más é seo do chéad eisiúint, beidh ort comhordú a dhéanamh le scaoilteoir eile chun na rudaí seo go léir a líneáil suas, agus scríobh chuig liosta seoltaí Ops ag iarraidh an rochtain agus na ceadanna riachtanacha.

• Timpeallacht Unix leis na huirlisí seo suiteáilte (in ord aibítre):

  • bash

  • git

  • GPG

  • déanamh

  • fear

  • uirlisí hashing (de ghnáth md5sum ``, `sha1sum, agus sha256sum ar Linux, nó md5 agus shasum` ar macOS)

  • python

• Péire eochair GPG. Cinntigh go bhfuil an chuid príobháideach den eochair seo stóráilte go daingean. Ní mór an chuid poiblí a uaslódáil chuig do chuntas GitHub, agus chuig freastalaí Jenkins a reáchtáil an post “scaoileadh deimhnithe”.

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

  Shell

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

  Ini

  [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:

  Ini

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

• Rochtain ar riarachán Django ar djangoproject.com mar “cothabhálaí láithreáin”.

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

• Rochtain ar an repo `` django-security`` i GitHub. I measc rudaí eile, soláthraíonn sé seo rochtain ar an liosta dáileacháin réamhfhógraí (a theastaíonn le haghaidh tascanna ullmhúcháin um scaoileadh slándála).

• Access to the Django project on Read the Docs.

Tascanna réamhscaoilteLink to this heading#

Ní mór aire a thabhairt do chúpla earra sula dtosaíonn tú fiú leis an bpróiseas scaoilte. Tosaíonn an stuif seo thart ar sheachtain roimh an scaoileadh; is féidir an chuid is mó de a dhéanamh am ar bith chun an scaoileadh iarbhír.

Feature freeze tasksLink to this heading#

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. Be sure to fetch and update upstream to latest. For example, when feature freezing Django 5.2:

   Shell

   $ git fetch upstream
   $ 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. Create Release entries for the next version in the `admin`__ on djangoproject.com. Add one for each milestone (alpha, beta, rc, and final), leaving is active unset to mark them as unreleased. Set target dates per the agreed schedule, and set the LTS flag if applicable. The X.Y roadmap page will be available at /download/X.Y/roadmap/.

   For example, when creating stable/5.2.x, add Release entries for 6.0a1, 6.0b1, 6.0rc1, and 6.0. The 6.0 roadmap can be then reviewed at https://www.djangoproject.com/download/6.0/roadmap/.

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"), update the Read the Docs config for the version to point to the slug A.B.x and set it as active. See more details.

7. Create a PR on PyPI proposing the new Trove classifier. For example Framework :: Django :: 5.2.

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

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

I ndáiríre an scaoilteLink to this heading#

Ceart go leor, is é seo an chuid spraíúil, áit a bhrúimid scaoileadh amach i ndáiríre! Má tá tú ag eisiúint ileisiúint, déan na céimeanna seo arís do gach scaoileadh.

1. Seiceáil go bhfuil `Jenkins `__ glas don leagan/na leaganacha atá tú ag cur amach. Is dócha nár cheart duit scaoileadh a eisiúint go dtí go mbeidh sé glas, agus ba cheart duit a chinntiú go gcuimsíonn an rith glas is déanaí na hathruithe atá á scaoileadh agat.

2. Glan na nótaí scaoilte don eisiúint seo. Déan na hathruithe seo i príom agus backport chuig gach brainse ina bhfuil na nótaí scaoilte do leagan áirithe suite.

   1. <1994a2643881a9e3f9fa8d3e0794c1a9933a1831>Le haghaidh scaoileadh gné, bain an ceannteideal UNDER DEVELOPMENT ag barr na nótaí scaoilte, bain an réimír ``Táthas ag súil leis ``agus nuashonraigh an dáta scaoilte, más gá (:commit: `example commit `).

   2. <34a503162fe222033a1cd3249bccad014fcd1d20>Le haghaidh scaoileadh paiste, bain an réimír ``Táim ag súil leis ``agus nuashonraigh an dáta scaoilte do gach eisiúint, más gá (:commit: `example commit `).

3. Tosaíonn scaoileadh i gcónaí ó bhrainse scaoilte, mar sin ba cheart duit a chinntiú go bhfuil tú ar bhrainse cobhsaí cothro Chomh maith leis sin, ba cheart go mbeadh timpeallacht fhíorúil glan tiomnaithe ar fáil agat in aghaidh an leagan atá Mar shampla:

   Shell

   $ git checkout stable/4.1.x
   $ git pull
   

4. Más scaoileadh slándála é seo, cumaisc na paistí cuí ó django-slándáil `. Athbhunaigh na paistí seo de réir mar is gá chun tiomantas simplí a dhéanamh ar gach ceann ar an mbrainse scaoilte seachas tiomantas cumaisc. Chun é seo a chinntiú, déan iad a chumasc leis an bhratach --ff-only; mar shampla:

   Shell

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

   (Glacann sé leis seo gur brainse sa repo django-slándála ina bhfuil na paistí slándála riachtanacha don chéad eisiúint eile sa tsraith 4.1 é slándálaí/4.1.x`.)

   Má dhiúltaíonn git cumasc le --ff-only, aistrigh go dtí an brainse paiste slándála agus athbhunaigh é ar an mbrainse atá ar tí é a chumasc isteach (git checkout security/4.1.x; git rebase stable/4.1.x) agus ansin athraigh ar ais agus déan an cumaisc. Déan cinnte go míníonn an teachtaireacht tiomanta do gach socrú slándála gur socrú slándála é an tiomantas agus go leanfaidh fógra (:commit: example security commit <bf39978a53f117ca02e9a0c78b76664a41a54745>).

5. Nuashonraigh an uimhir leagan i django/__init__.py don scaoileadh. <2719a7f8c161233f45d34b624a9df9392c86cc1b>Féach le do thoil nótaí maidir le feadán VERSION a shocraí thíos le haghaidh sonraí faoi VERSION` (:commit: `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. Seachas sin, déan cinnte go bhfuil an aicmitheoir socraithe go Stádas Forbartha:: 5 - Táirgeacht/Cobhsa.

An scaoileadh (í) a chur ar fáil don phobalLink to this heading#

Anois tá tú réidh chun an scaoileadh a chur amuigh ansin i ndáiríre. Chun seo a dhéanamh:

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:

   Leagan

   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. Rith an tógáil `confirm-release`__ ar Jenkins chun an comhad (í) seicsum a fhíorú (m.sh. bain úsáid as 4.2rc1` le haghaidh https://media.djangoproject.com/pgp/Django-4.2rc1.checksum.txt).

4. Upload the release packages to PyPI:

   Shell

   $ twine upload --repository django dist/*
   

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

6. Brúigh do chuid oibre agus an chlib nua:

   Shell

   $ git push
   $ git push --tags
   

7. Déan an blag post ag fógairt an scaoileadh beo.

8. Le haghaidh scaoileadh leagan nua (m.sh. 4.1, 4.2), nuashonraigh an leagan cobhsaí réamhshocraithe de na doiciméid tríd an bhratach is_default a fhilleadh go True` ar an réad cuí DocumentRelease` sa bhunachar sonraí docs.djangoproject.com (déanfaidh sé seo go huathoibríoch go False` do gach duine eile).

   Cruthaigh rudaí nua DocumentRelease do gach teanga a bhfuil iontráil aige don eisiúint roimhe seo. Nuashonraigh comhad `robots.docs.txt`__ djangoproject.com tríd an toradh a ghintear ón ordú manage_translations.py robots_txt` a reáchtáil sa bhrainse chobhsaí reatha ón stóras `django-docs-translationy`__. Mar shampla, agus Django 4.2 á scaoileadh:

   Shell

   $ 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, publish the CVE metadata. (The checklist app generates JSON for this.):

    Shell

    $ cve publish <cve-number> --cve-json-file <path-to-file>
    

11. If this is a security release, send a separate email to oss-security@lists.openwall.com. Provide "Django" plus the CVE IDs in the subject line. The message body should include the vulnerability details, for example, the announcement blog post text. Include a link to the announcement blog post.

Iar-scaoileadhLink to this heading#

Tá tú beagnach déanta! Níl le déanamh anois ach:

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. If this was an alpha release:

   1. Add the feature release version in Trac's versions list.

   2. Create a new security branch from the freshly cut stable branch. Be sure to fetch and update upstream to latest. For example, after the 5.2 alpha release:

      Shell

      $ git fetch upstream
      $ git checkout -b security/5.2.x upstream/stable/5.2.x
      $ git push origin -u security/5.2.x:security/5.2.x
      

3. Más scaoileadh deiridh é seo:

   1. Update the default_version setting in the code.djangoproject.com's trac.ini file (example PR).

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

   3. < https://github.com/django/djangoproject.com/pull/1444>Nuashonraigh leathanach íoslódála djangoproject.com (`sampla PR`__).

   4. Process the older versions that will reach End-Of-Mainstream and/or End-Of-Life support when this final release is published:

      1. Ensure that the EOL versions are mentioned in the blog post. See example announcement.

      2. Create a tag for the EOL stable branch and delete the stable branch. Inspect and use the scripts/archive_eol_stable_branches.py helper.

4. Más scaoileadh slándála a bhí ann, déan nuashonraithe:doc: `/releases/security `le sonraí na saincheisteanna a ndearnadh aghaidh orthu.

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:

      Shell

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

      Shell

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

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

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

6. If this was an alpha pre-release, coordinate with the maintainer of asgiref to determine when to raise the minimum version before the final release. For the backport, add an upper bound on the next major version (example commits: main, backport).

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

Nótaí maidir leis an tuple VERSION a shocrúLink to this heading#

Tá tuairisciú leagan Django á rialú ag an tuipéal VERSION i django/__init__.py`. Is tuple cúig ghné é seo, a bhfuil a n-eilimintí:

1. Leagan mór.

2. Leagan mion.

3. Leagan micrea-leagan.

4. Stádas - is féidir a bheith ar cheann de “alfa”, “béite”, “rc” nó “críochnaitheach”.

5. Uimhir an tsraith, le haghaidh pacáistí alpha/beta/RC a ritheann i seicheamh (ag ceadú, mar shampla, “béita 1", “béite 2", srl.).

Le haghaidh scaoileadh deiridh, bíonn an stádas “deiridh” i gcónaí agus is é uimhir na sraithe i gcónaí 0. Tuairiscítear uimhir shraith 0 le stádas “alfa” mar “réamh-alfa”.

Roinnt samplaí:

• (4, 1, 1, “deiridh”, 0) → “4.1.1"

• (4, 2, 0, “alfa”, 0) → “4.2 réamh-alfa”

• (4, 2, 0, “béite”, 1) → “4.2 béite 1"