Skip to content

Commit 19e53e5

Browse files
committed
add in explicit instructions on how to release a new version
1 parent b09c38d commit 19e53e5

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

Makefile

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ help: ## Show this help. (Default target)
99

1010
.DEFAULT_GOAL := help
1111

12-
.PHONY : install install-poetry run-nox-all run-nox-session format run-quick-test ipython-shell
12+
.PHONY : install install-poetry run-nox-all run-nox-session format run-quick-test ipython-shell new-version
1313

1414
install-poetry: .poetry/bin/poetry ## Install poetry in the project.
1515
$< install
@@ -41,8 +41,16 @@ format: .poetry/bin/poetry ## Format the code by running isort and black on the
4141
$< run isort .
4242
$< run black .
4343

44+
new-version: ## Release a new version Use: make new-version-<patch|minor|major|prepatch|preminor|premajor|prerelease>
45+
@echo "NOTE: please run make new-version-<patch|minor|major|prepatch|preminor|premajor|prerelease> to make a new version"
46+
4447
new-version-%: .poetry/bin/poetry ## Make a new version. Use: make new-version-<patch|minor|major|prepatch|preminor|premajor|prerelease>
4548
$< version -- $*
46-
49+
$(eval NEW_VERSION = $(shell $< version -s))
50+
@echo NOTE: You must now commit and push the changes made by the make $@ command to initialize the release action on Github.
51+
@echo Suggested commands:
52+
@echo git add pyproject.toml
53+
@echo git commit -m \'Release v$(NEW_VERSION)\'
54+
@echo git push
4755
guard-%: .poetry/bin/poetry ## Used to ensure an env var is available for a target that depends on guard-%
4856
@if [ -z '${${*}}' ]; then echo 'Variable $* not set. You can set it with $*=VALUE make ...' && exit 1; fi

0 commit comments

Comments
 (0)