From bdd45c394c6be55fd94a58190409e8c77a9461c5 Mon Sep 17 00:00:00 2001 From: Andrew Montanez Date: Wed, 13 Sep 2023 10:34:51 -0500 Subject: [PATCH] Switch default branch from master to main (#361) --- CONTRIBUTING.rst | 6 +++--- INSTALL.md | 4 ++-- Makefile | 34 +++++++++++++++++----------------- README.md | 6 +++--- RELEASE.md | 4 ++-- docs/conf.py | 2 +- 6 files changed, 28 insertions(+), 28 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ad324f47..e94f60dc 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -166,16 +166,16 @@ Release Workflow The process of releasing a new version involves several steps combining both ``git`` and ``bumpversion`` which, briefly: -1. Merge what is in ``master`` branch into ``stable`` branch. +1. Merge what is in ``main`` branch into ``stable`` branch. 2. Update the version in ``setup.cfg``, ``copulas/__init__.py`` and ``HISTORY.md`` files. 3. Create a new TAG pointing at the correspoding commit in ``stable`` branch. -4. Merge the new commit from ``stable`` into ``master``. +4. Merge the new commit from ``stable`` into ``main``. 5. Update the version in ``setup.cfg`` and ``copulas/__init__.py`` to open the next development interation. **Note:** Before starting the process, make sure that ``HISTORY.md`` has a section titled **Unreleased** with the list of changes that will be included in the new version, and that -these changes are committed and available in ``master`` branch. +these changes are committed and available in ``main`` branch. Normally this is just a list of the Pull Requests that have been merged since the latest version. Once this is done, run of the following commands: diff --git a/INSTALL.md b/INSTALL.md index 531634bb..9aad1ac6 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -47,12 +47,12 @@ make install If you intend to modify the source code or contribute to the project you will need to install it from the source using the `make install-develop` command. In this case, we -recommend you to branch from `master` first: +recommend you to branch from `main` first: ```bash git clone git@github.com:sdv-dev/Copulas cd Copulas -git checkout master +git checkout main git checkout -b make install-develp ``` diff --git a/Makefile b/Makefile index a61c117a..7df83ac8 100644 --- a/Makefile +++ b/Makefile @@ -177,14 +177,14 @@ publish-test: dist publish-confirm ## package and upload a release on TestPyPI publish: dist publish-confirm ## package and upload a release twine upload dist/* -.PHONY: git-merge-master-stable -git-merge-master-stable: ## Merge master into stable +.PHONY: git-merge-main-stable +git-merge-main-stable: ## Merge main into stable git checkout stable || git checkout -b stable - git merge --no-ff master -m"make release-tag: Merge branch 'master' into stable" + git merge --no-ff main -m"make release-tag: Merge branch 'main' into stable" -.PHONY: git-merge-stable-master -git-merge-stable-master: ## Merge stable into master - git checkout master +.PHONY: git-merge-stable-main +git-merge-stable-main: ## Merge stable into main + git checkout main git merge stable .PHONY: git-push @@ -218,7 +218,7 @@ bumpversion-major: ## Bump the version the next major skipping the release .PHONY: bumpversion-revert bumpversion-revert: ## Undo a previous bumpversion-release git tag --delete $(shell git tag --points-at HEAD) - git checkout master + git checkout main git branch -D stable CLEAN_DIR := $(shell git status --short | grep -v ??) @@ -232,10 +232,10 @@ ifneq ($(CLEAN_DIR),) $(error There are uncommitted changes) endif -.PHONY: check-master -check-master: ## Check if we are in master branch -ifneq ($(CURRENT_BRANCH),master) - $(error Please make the release from master branch\n) +.PHONY: check-main +check-main: ## Check if we are in main branch +ifneq ($(CURRENT_BRANCH),main) + $(error Please make the release from main branch\n) endif .PHONY: check-candidate @@ -251,18 +251,18 @@ ifeq ($(CHANGELOG_LINES),0) endif .PHONY: check-release -check-release: check-clean check-candidate check-master check-history ## Check if the release can be made +check-release: check-clean check-candidate check-main check-history ## Check if the release can be made @echo "A new release can be made" .PHONY: release -release: check-release git-merge-master-stable bumpversion-release git-push-tags-stable \ - publish git-merge-stable-master bumpversion-patch git-push +release: check-release git-merge-main-stable bumpversion-release git-push-tags-stable \ + publish git-merge-stable-main bumpversion-patch git-push .PHONY: release-test -release-test: check-release git-merge-master-stable bumpversion-release bumpversion-revert +release-test: check-release git-merge-main-stable bumpversion-release bumpversion-revert .PHONY: release-candidate -release-candidate: check-master publish bumpversion-candidate git-push +release-candidate: check-main publish bumpversion-candidate git-push .PHONY: release-candidate-test -release-candidate-test: check-clean check-master publish-test +release-candidate-test: check-clean check-main publish-test diff --git a/README.md b/README.md index 246218b3..6e53ea35 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ [![PyPi Shield](https://img.shields.io/pypi/v/copulas.svg)](https://pypi.python.org/pypi/copulas) [![Downloads](https://pepy.tech/badge/copulas)](https://pepy.tech/project/copulas) [![Unit Tests](https://github.com/sdv-dev/Copulas/actions/workflows/unit.yml/badge.svg)](https://github.com/sdv-dev/Copulas/actions/workflows/unit.yml) -[![Coverage Status](https://codecov.io/gh/sdv-dev/Copulas/branch/master/graph/badge.svg)](https://codecov.io/gh/sdv-dev/Copulas) +[![Coverage Status](https://codecov.io/gh/sdv-dev/Copulas/branch/main/graph/badge.svg)](https://codecov.io/gh/sdv-dev/Copulas) [![Slack](https://img.shields.io/badge/Community-Slack-blue?style=plastic&logo=slack)](https://bit.ly/sdv-slack-invite)

- +

@@ -110,7 +110,7 @@ Thank you to our team of contributors who have built and maintained the library
- +


diff --git a/RELEASE.md b/RELEASE.md index dac22c1a..60284854 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -36,7 +36,7 @@ Clone the project and install the development requirements before start the rele ```bash git clone https://github.com/sdv-dev/Copulas.git cd Copulas -git checkout master +git checkout main make install-develop ``` @@ -183,7 +183,7 @@ Clone the project and install the development requirements. Alternatively, with ```bash git clone https://github.com/sdv-dev/SDV cd SDV -git checkout master +git checkout main make install-develop ``` diff --git a/docs/conf.py b/docs/conf.py index c189c9c6..2e7bb8ef 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -104,7 +104,7 @@ 'display_github': True, 'github_user': user, 'github_repo': project, - 'github_version': 'master', + 'github_version': 'main', 'conf_py_path': '/docs/', }