Skip to content

Commit

Permalink
Switch default branch from master to main
Browse files Browse the repository at this point in the history
  • Loading branch information
amontanez24 committed Sep 12, 2023
1 parent 6a96d8e commit ea8fdd7
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 28 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]:sdv-dev/Copulas
cd Copulas
git checkout master
git checkout main
git checkout -b <your-branch-name>
make install-develp
```
Expand Down
34 changes: 17 additions & 17 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 ??)
Expand All @@ -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
Expand All @@ -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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<br/>
<p align="center" style="text-align:center">
<a href="https://github.com/sdv-dev/Copulas">
<img width=40% src="https://github.com/sdv-dev/SDV/blob/master/docs/images/Copulas-DataCebo.png?raw=true"></img>
<img width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/Copulas-DataCebo.png?raw=true"></img>
</a>
</p>

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


<div align="center">
<a href="https://datacebo.com"><img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/master/docs/images/DataCebo.png"></img></a>
<a href="https://datacebo.com"><img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/DataCebo.png"></img></a>
</div>
<br/>
<br/>
Expand Down
4 changes: 2 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
'display_github': True,
'github_user': user,
'github_repo': project,
'github_version': 'master',
'github_version': 'main',
'conf_py_path': '/docs/',
}

Expand Down

0 comments on commit ea8fdd7

Please sign in to comment.