From 6181f3b10a452319b5a1d8e370bc275c033d0909 Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Thu, 20 Jun 2024 14:26:47 +0100 Subject: [PATCH 1/4] Update documentation to use main branch --- CHANGES.rst | 2 ++ docs/maintenance.rst | 12 ++++++------ 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 4dcf56bd..34aa2bbf 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -7,6 +7,8 @@ Changelog Minor changes: - Test that all code works with both ``pytz`` and ``zoneinfo``. +- Rename ``master`` branch to ``main``, see `Issue + `_ Breaking changes: diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 7b8f33c7..d0dc941f 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -70,9 +70,9 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app .. code-block:: bash - git checkout master + git checkout main git pull - git checkout -b release master + git checkout -b release main git add CHANGES.rst src/icalendar/__init__.py docs/install.rst git commit -m"version 5.0.0" @@ -90,7 +90,7 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app .. code-block:: bash - git checkout master + git checkout main git pull git branch -d release git push -d origin release @@ -99,7 +99,7 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app .. code-block:: bash - git checkout master + git checkout main git pull git tag v5.0.0 git push upstream v5.0.0 # could be origin or whatever reference @@ -137,13 +137,13 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app .. code-block:: bash - git checkout master + git checkout main git pull git add CHANGES.rst git commit -m"Add new CHANGELOG section for future release See https://icalendar.readthedocs.io/en/latest/maintenance.html#new-releases" - git push upstream master # could be origin or whatever reference + git push upstream main # could be origin or whatever reference Links ----- From 0daeceff028e078724acaf14c6a1b9a4113a4dd2 Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Thu, 20 Jun 2024 14:27:30 +0100 Subject: [PATCH 2/4] Update README to use main branch --- README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 8ce4dae2..45987c9e 100644 --- a/README.rst +++ b/README.rst @@ -24,9 +24,9 @@ files. :target: https://pypi.org/project/icalendar/#files :alt: Downloads from PyPI -.. image:: https://img.shields.io/github/actions/workflow/status/collective/icalendar/tests.yml?branch=master&label=master&logo=github - :target: https://github.com/collective/icalendar/actions/workflows/tests.yml?query=branch%3Amaster - :alt: GitHub Actions build status for master +.. image:: https://img.shields.io/github/actions/workflow/status/collective/icalendar/tests.yml?branch=main&label=main&logo=github + :target: https://github.com/collective/icalendar/actions/workflows/tests.yml?query=branch%3Amain + :alt: GitHub Actions build status for main .. image:: https://img.shields.io/github/actions/workflow/status/collective/icalendar/tests.yml?branch=4.x&label=4.x&logo=github :target: https://github.com/collective/icalendar/actions/workflows/tests.yml?query=branch%3A4.x++ @@ -175,8 +175,8 @@ you can receive all the latest updates, and switch back to version 5.x behavior: >>> dt.tzinfo -Version 6 is on `branch master `_ with compatibility to Python versions ``3.7+`` and ``PyPy3``. -We expect the ``master`` branch with versions ``6+`` to receive the latest updates and features. +Version 6 is on `branch main `_ with compatibility to Python versions ``3.7+`` and ``PyPy3``. +We expect the ``main`` branch with versions ``6+`` to receive the latest updates and features. Version 5 ~~~~~~~~~ From c29074d3d2ee830565de6faefd35a08b5c515a50 Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Fri, 21 Jun 2024 17:55:31 +0100 Subject: [PATCH 3/4] rename branch link to main --- docs/usage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage.rst b/docs/usage.rst index 4194577c..a4d396c0 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -372,5 +372,5 @@ Print out the calendar:: More documentation ================== -Have a look at the `tests `__ of this package to get more examples. +Have a look at the `tests `__ of this package to get more examples. All modules and classes docstrings, which document how they work. From 752928cea762a1e89b645428127ca33760b9a69f Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Sat, 22 Jun 2024 17:45:02 +0100 Subject: [PATCH 4/4] rename master to main to make the history of the project easier to understand --- CHANGES.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 34aa2bbf..b49458f2 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -325,7 +325,7 @@ New features: - No longer test on Python 3.4, 3.5 and PyPy2, because we cannot get it to work. Technically it should still work, it is just no longer tested. Do not expect much development on branch 4.x anymore. - The master branch will be for the remaining Python versions that we support. + The main branch will be for the remaining Python versions that we support. [maurits] Bug fixes: @@ -965,7 +965,7 @@ Fixes: [garbas] - hook out github repository to https://readthedocs.org service so sphinx - documentation is generated on each commit (for master). Documentation can be + documentation is generated on each commit (for main). Documentation can be visible on: https://icalendar.readthedocs.io/en/latest/ [garbas]