diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 62d1a08..0205c61 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -174,17 +174,17 @@ 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``, ``deepecho/__init__.py`` and ``HISTORY.md`` files. 3. Create a new git tag pointing at the corresponding 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 ``deepecho/__init__.py`` to open the next development iteration. .. note:: Before starting the process, make sure that ``HISTORY.md`` has been updated with a new entry that explains the changes that will be included in the new version. - Normally this is just a list of the Pull Requests that have been merged to master + Normally this is just a list of the Pull Requests that have been merged to main since the last release. Once this is done, run of the following commands: diff --git a/INSTALL.md b/INSTALL.md index 132da72..daebeb8 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/DeepEcho cd DeepEcho -git checkout master +git checkout main git checkout -b make install-develp ``` diff --git a/Makefile b/Makefile index d8b28c3..76bb787 100644 --- a/Makefile +++ b/Makefile @@ -165,22 +165,22 @@ publish: dist publish-confirm ## package and upload a release twine upload dist/* .PHONY: bumpversion-release -bumpversion-release: ## Merge master to stable and bumpversion release +bumpversion-release: ## Merge main to stable and bumpversion release 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" bumpversion release git push --tags origin stable .PHONY: bumpversion-release-test -bumpversion-release-test: ## Merge master to stable and bumpversion release +bumpversion-release-test: ## Merge main to stable and bumpversion release 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" bumpversion release --no-tag @echo git push --tags origin stable .PHONY: bumpversion-patch -bumpversion-patch: ## Merge stable to master and bumpversion patch - git checkout master +bumpversion-patch: ## Merge stable to main and bumpversion patch + git checkout main git merge stable bumpversion --no-tag patch git push @@ -199,7 +199,7 @@ bumpversion-major: ## Bump the version the next major skipping the release .PHONY: bumpversion-revert bumpversion-revert: ## Undo a previous bumpversion-release - git checkout master + git checkout main git branch -D stable CLEAN_DIR := $(shell git status --short | grep -v ??) @@ -213,10 +213,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 @@ -232,7 +232,7 @@ 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 @@ -242,7 +242,7 @@ release: check-release bumpversion-release publish bumpversion-patch release-test: check-release bumpversion-release-test publish-test bumpversion-revert .PHONY: release-candidate -release-candidate: check-master publish bumpversion-candidate +release-candidate: check-main publish bumpversion-candidate .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 70960eb..d145073 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,17 @@ [![Development Status](https://img.shields.io/badge/Development%20Status-2%20--%20Pre--Alpha-yellow)](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha) [![PyPi Shield](https://img.shields.io/pypi/v/deepecho.svg)](https://pypi.python.org/pypi/deepecho) -[![Tests](https://github.com/sdv-dev/DeepEcho/workflows/Run%20Tests/badge.svg)](https://github.com/sdv-dev/DeepEcho/actions?query=workflow%3A%22Run+Tests%22+branch%3Amaster) +[![Tests](https://github.com/sdv-dev/DeepEcho/workflows/Run%20Tests/badge.svg)](https://github.com/sdv-dev/DeepEcho/actions?query=workflow%3A%22Run+Tests%22+branch%3Amain) [![Downloads](https://pepy.tech/badge/deepecho)](https://pepy.tech/project/deepecho) -[![Coverage Status](https://codecov.io/gh/sdv-dev/DeepEcho/branch/master/graph/badge.svg)](https://codecov.io/gh/sdv-dev/DeepEcho) -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/sdv-dev/DeepEcho/master?filepath=tutorials/timeseries_data) +[![Coverage Status](https://codecov.io/gh/sdv-dev/DeepEcho/branch/main/graph/badge.svg)](https://codecov.io/gh/sdv-dev/DeepEcho) +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/sdv-dev/DeepEcho/main?filepath=tutorials/timeseries_data) [![Slack](https://img.shields.io/badge/Slack%20Workspace-Join%20now!-36C5F0?logo=slack)](https://bit.ly/sdv-slack-invite)

- +

@@ -49,12 +49,12 @@ time series**. It provides: [SDV Blog]: https://sdv.dev/blog [Documentation]: https://sdv.dev/SDV [Repository]: https://github.com/sdv-dev/DeepEcho -[License]: https://github.com/sdv-dev/DeepEcho/blob/master/LICENSE +[License]: https://github.com/sdv-dev/DeepEcho/blob/main/LICENSE [Development Status]: https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha -[Slack Logo]: https://github.com/sdv-dev/SDV/blob/master/docs/images/slack.png +[Slack Logo]: https://github.com/sdv-dev/SDV/blob/stable/docs/images/slack.png [Community]: https://bit.ly/sdv-slack-invite -[MyBinder Logo]: https://github.com/sdv-dev/SDV/blob/master/docs/images/mybinder.png -[Tutorials]: https://mybinder.org/v2/gh/sdv-dev/DeepEcho/master?filepath=tutorials +[MyBinder Logo]: https://github.com/sdv-dev/SDV/blob/stable/docs/images/mybinder.png +[Tutorials]: https://mybinder.org/v2/gh/sdv-dev/DeepEcho/main?filepath=tutorials # Install @@ -160,7 +160,7 @@ us developing new features or cool ideas!
- +