You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f53a5b7
Browse filesBrowse the repository at this point in the historyBrowse files
If it expires, push a new tag with a bumped version number.
252
265
253
266
#. Update the version switcher file :file:`docs/_static/version-switcher.json`.
254
267
@@ -365,18 +378,18 @@ However, only people with ``Environments/Configure PyPI`` access can approve an
365
378
366
379
#. Advance the ``*.x`` stable branch to the new tag so it stays current for future backports.
367
380
381
+
.. note::
382
+
383
+
If the stable branch is behind the latest tag, push it forward before starting any backport.
384
+
A branch that's out of date causes cherry-pick conflicts and forces a version bump.
385
+
368
386
.. code-block:: shell
369
387
370
388
git checkout 7.x
371
389
git pull
372
390
git merge main
373
391
git push # to PyCalendar/icalendar
374
392
375
-
.. note::
376
-
377
-
If the stable branch is behind the latest tag, push it forward before starting any backport.
378
-
A branch that's out of date causes cherry-pick conflicts and forces a version bump.
379
-
380
393
#. Add a comment to each of the issues mentioned in the new release.
381
394
382
395
.. code-block:: text
@@ -389,12 +402,12 @@ Pre-releases
389
402
------------
390
403
391
404
Pre-releases use `PEP440<https://peps.python.org/pep-0440/>`_ suffixes: ``8.0.0a1``, ``8.0.0b1``, ``8.0.0rc1``.
392
-
The release steps are the same as a standard release, withthese differences.
405
+
The release steps are the same as a standard release, withthe following differences.
393
406
394
407
The tag goes on ``main``, not on a ``*.x`` branch.
395
408
When the stable branch is eventually cut, follow the standard process from :ref:`new-releases`.
396
409
397
-
After the GitHub releaseis created, check that the :guilabel:`This is a pre-release` checkbox isset on the release page.
410
+
After you create the GitHub release, check that the :guilabel:`This is a pre-release` checkbox isset on the release page.
398
411
The workflow sets it automatically forPEP440 pre-release version tags.
399
412
If the checkbox isnotset, edit the release on GitHub andset it manually before the release is widely announced.
400
413
@@ -433,9 +446,9 @@ A backport release cherry-picks specific commits onto a ``*.x`` stable branch to
433
446
git cherry-pick <commit-hash> [<commit-hash>...]
434
447
435
448
Conflicts between branches are common, usually around error types or control-flow that diverged.
436
-
After resolving, run ``pytest`` to confirm no new failures.
449
+
After resolvingany conflicts, run ``pytest`` to confirm that tests pass.
437
450
438
-
#. Add a news fragment in ``news/``, then build the changelog:
451
+
#. Add a news fragment in ``news/``, then build the change log:
439
452
440
453
.. code-block:: shell
441
454
@@ -458,13 +471,15 @@ A backport release cherry-picks specific commits onto a ``*.x`` stable branch to
458
471
459
472
.. warning::
460
473
461
-
Tags cannot be moved or deleted once pushed.
462
-
If a release turns out to be broken, cut a new version; don't attempt to retag.
474
+
Tags can't be moved or deleted once pushed.
475
+
If a release turns out to be broken, cut a new version.
476
+
Don't attempt to retag.
463
477
See :issue:`1033`.
464
478
465
479
#. Approve the ``deploy-tag-to-pypi`` and ``deploy-github-release`` jobs in `GitHub Actions <https://github.com/PyCalendar/icalendar/actions>`_ when they appear.
466
480
Only maintainers listed as Required Reviewers in :menuselection:`Settings --> Environments --> PyPI` can approve.
467
-
The approval window is30 days; after that you'd need to retag with a new version.
481
+
The approval window is30 days.
482
+
After that, you'd need to retag the commit with a new version.
468
483
469
484
#. Comment on each fixed issue:
470
485
@@ -478,7 +493,7 @@ A backport release cherry-picks specific commits onto a ``*.x`` stable branch to
478
493
Security releases
479
494
-----------------
480
495
481
-
A security release follows the :ref:`backport-releases` process, with embargo until the fix ships.
496
+
A security release follows the :ref:`backport-releases` process, withan embargo until the fix ships.
482
497
483
498
#. Don't discuss the vulnerability publicly until the fix is released.
484
499
If someone files a public issue, ask them to use `GitHub's private vulnerability reporting <https://github.com/PyCalendar/icalendar/security/advisories/new>`_ instead, and close the public issue.
@@ -502,7 +517,7 @@ Links
502
517
503
518
This section contains useful links for maintainers and collaborators.
504
519
505
-
- To remove private information from an iCalendar filefor bug reports, use `icalendar-anonymizer <https://github.com/pycalendar/icalendar-anonymizer>`_ either through its `website <https://icalendar-anonymizer.com/>`_ or`install it locally <https://docs.icalendar-anonymizer.com/latest/installation.html>`_.
520
+
- To remove private information from an iCalendar filefor bug reports, use `icalendar-anonymizer <https://github.com/PyCalendar/icalendar-anonymizer>`_ either through its `website <https://icalendar-anonymizer.com/>`_ or`install it locally <https://docs.icalendar-anonymizer.com/latest/installation.html>`_.
0 commit comments