Skip to content

Commit

Permalink
Merge pull request #633 from niccokunzmann/rename-master-to-main
Browse files Browse the repository at this point in the history
Rename master to main in docs
  • Loading branch information
jacadzaca committed Jun 23, 2024
2 parents e27ee68 + 752928c commit f7f0c20
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 14 deletions.
6 changes: 4 additions & 2 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Changelog
Minor changes:

- Test that all code works with both ``pytz`` and ``zoneinfo``.
- Rename ``master`` branch to ``main``, see `Issue
<https://github.com/collective/icalendar/issues/627>`_

- Added missing public classes and functions to API documentation.
- Add version badge
Expand Down Expand Up @@ -323,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:
Expand Down Expand Up @@ -963,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]

Expand Down
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,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++
Expand Down Expand Up @@ -178,8 +178,8 @@ you can receive all the latest updates, and switch back to version 5.x behavior:
>>> dt.tzinfo
<DstTzInfo 'Europe/Vienna' CET+1:00:00 STD>
Version 6 is on `branch master <https://github.com/collective/icalendar/>`_ 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 <https://github.com/collective/icalendar/>`_ 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
~~~~~~~~~
Expand Down
12 changes: 6 additions & 6 deletions docs/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
-----
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -372,5 +372,5 @@ Print out the calendar::
More documentation
==================

Have a look at the `tests <https://github.com/collective/icalendar/tree/master/src/icalendar/tests>`__ of this package to get more examples.
Have a look at the `tests <https://github.com/collective/icalendar/tree/main/src/icalendar/tests>`__ of this package to get more examples.
All modules and classes docstrings, which document how they work.

0 comments on commit f7f0c20

Please sign in to comment.