Skip to content

Rename repository branches #1699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2024
Merged

Rename repository branches #1699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ Your PR description goes here.
Thanks again for your contribution!
-->

[contributing-guidelines]: https://github.com/vacanza/python-holidays/blob/beta/CONTRIBUTING.rst
[docs]: https://github.com/vacanza/python-holidays/tree/beta/docs/source
[contributing-guidelines]: https://github.com/vacanza/python-holidays/blob/dev/CONTRIBUTING.rst
[docs]: https://github.com/vacanza/python-holidays/tree/dev/docs/source
4 changes: 2 additions & 2 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ updates:
schedule:
interval: weekly
day: wednesday
target-branch: beta
target-branch: dev

- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
day: wednesday
target-branch: beta
target-branch: dev
2 changes: 1 addition & 1 deletion .github/workflows/pre-commit-autoupdate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:

- uses: peter-evans/[email protected]
with:
base: beta
base: dev
body: Update pre-commit hooks to their latest versions.
branch: update-pre-commit-hooks
commit-message: 'chore: Update pre-commit hooks'
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Contributing
============

.. _prs: https://github.com/vacanza/python-holidays/pulls
.. _`beta branch`: https://github.com/vacanza/python-holidays/tree/beta
.. _`dev branch`: https://github.com/vacanza/python-holidays/tree/dev
.. |contributors| image:: https://img.shields.io/github/contributors/vacanza/python-holidays
:target: https://github.com/vacanza/python-holidays/graphs/contributors
:alt: contributors
Expand All @@ -15,7 +15,7 @@ Basics
------

When contributing with fixes and new features, please start forking/branching
from the `beta branch`_ to work on the latest code and reduce merging issues.
from the `dev branch`_ to work on the latest code and reduce merging issues.
If you add/change holiday official dates or names you must include references to
all sources (government sites, archived web pages, wiki pages, etc) you've used
while working on this PR. Contributed PRs_ are required to include valid test
Expand Down
14 changes: 7 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ flexible as possible.
:target: https://github.com/psf/black
:alt: Code style

.. image:: https://img.shields.io/coverallsCoverage/github/vacanza/python-holidays?branch=master&color=%2341B5BE&style=flat
.. image:: https://img.shields.io/coverallsCoverage/github/vacanza/python-holidays?branch=main&color=%2341B5BE&style=flat
:target: https://coveralls.io/r/vacanza/python-holidays
:alt: Code coverage

Expand All @@ -60,8 +60,8 @@ flexible as possible.
:target: https://github.com/vacanza/python-holidays/graphs/contributors
:alt: GitHub contributors

.. image:: https://img.shields.io/github/last-commit/vacanza/python-holidays/beta?color=%2341BE4A&style=flat
:target: https://github.com/vacanza/python-holidays/commits/beta
.. image:: https://img.shields.io/github/last-commit/vacanza/python-holidays/dev?color=%2341BE4A&style=flat
:target: https://github.com/vacanza/python-holidays/commits/dev
:alt: GitHub last commit


Expand All @@ -74,14 +74,14 @@ The latest stable version can always be installed or updated via pip:

$ pip install --upgrade holidays

The latest development (beta) version can be installed directly from GitHub:
The latest development (dev) version can be installed directly from GitHub:

.. code-block:: shell

$ pip install --upgrade https://github.com/vacanza/python-holidays/tarball/beta
$ pip install --upgrade https://github.com/vacanza/python-holidays/tarball/dev

All new features are always first pushed to beta branch, then released on
master branch upon official version upgrades.
All new features are always first pushed to dev branch, then released on
main branch upon official version upgrades.

Documentation
-------------
Expand Down
24 changes: 12 additions & 12 deletions RELEASE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ How to release a new version of Python Holidays

- Finalize the current development version

- switch to ``beta`` branch and pull the most recent changes
from https://github.com/vacanza/python-holidays remote ``beta`` branch.
- switch to ``dev`` branch and pull the most recent changes
from https://github.com/vacanza/python-holidays remote ``dev`` branch.
- generate release notes by running the following script
``scripts/generate_release_notes.py``
- insert the script's output into the top of ``CHANGES`` file
(see previous release notes for consistent formatting)
- commit the updated ``CHANGES`` file to ``beta`` branch with the following
- commit the updated ``CHANGES`` file to ``dev`` branch with the following
commit message 'Finalize v<version>', e.g. 'Finalize v0.39'
- push changes to https://github.com/vacanza/python-holidays ``beta`` branch
- push changes to https://github.com/vacanza/python-holidays ``dev`` branch
- make sure the push related CI/CD job(s) have been completed successfully

- Merge the finalized changes into ``master`` branch:
- Merge the finalized changes into ``main`` branch:

- create a new PR for the recent changes from ``beta`` to ``master`` branch
- create a new PR for the recent changes from ``dev`` to ``main`` branch
using 'v<version>' as a PR title and the previously generated release notes
as a PR description
- get the PR reviewed by at least one of the code owners
- merge the PR into ``master`` branch with 'Create a merge commit' action
- merge the PR into ``main`` branch with 'Create a merge commit' action
(**do not use 'Squash and merge'**)
- make sure the PR related CI/CD job(s) have been completed successfully
- make sure readthedocs.org documentation build jobs at
Expand All @@ -33,7 +33,7 @@ How to release a new version of Python Holidays
on the 'Draft a new release' button
- click on 'Choose a tag', enter 'v<version>' into the input field
(you should see something like 'Create a new tag: v0.39' on publish'
- select **master** - instead of default ``beta`` in 'Target' dropdown
- select **main** - instead of default ``dev`` in 'Target' dropdown
- put 'v<version>' into 'Release title' field, e.g. 'v0.39'
- click on 'Generate release notes' button to collect new contributors and
full changelog link information (we normally keep it at the bottom with
Expand All @@ -57,12 +57,12 @@ How to release a new version of Python Holidays

- send "Python Holidays 'v<version>' has been released!" (or similar) message
to Vacanza Team Slack #release channel
- pull the recent changes from ``master`` branch into ``beta``
- pull the recent changes from ``main`` branch into ``dev``
- bump the Python Holidays version at ``holidays/__init__.py`` file
- create a commit with 'Initialize v<version>' message, e.g.
'Initialize v0.40' and push it to ``beta`` branch (this may require
'Initialize v0.40' and push it to ``dev`` branch (this may require
running ``make package`` to pass the tests locally)
- make sure ``beta`` branch **is not behind** the master branch (there
- make sure ``dev`` branch **is not behind** the ``main`` branch (there
will be a message on top of the
https://github.com/vacanza/python-holidays/tree/beta page in case it is)
https://github.com/vacanza/python-holidays/tree/dev page in case it is)
- make sure the push related CI/CD job(s) have been completed successfully
2 changes: 1 addition & 1 deletion scripts/generate_release_notes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
sys.path.append(f"{Path.cwd()}")
import holidays # noqa: E402

BRANCH_NAME = "beta"
BRANCH_NAME = "dev"
HEADER_TEMPLATE = """
Version {version}
============
Expand Down