diff --git a/CHANGELOG.md b/CHANGELOG.md index f9badfb..bd52ecc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -81,3 +81,17 @@ First release. Contains support for: - vscode editor configuration including debugging support, unit test discovery and on-save formatting - Dockerized builds and run with nginx/uwsgi - Publishing to PyPi.org at + +## How to release a new version + +- Finish development on branch and merge to main +- Update this changelog and commit +- Bump version number in `pyproject.toml` +- Run + +```shell +VERSION=$( poetry version --short ) &&\ +echo "Release: ${VERSION}" &&\ +git tag -a ${VERSION} -m "Version ${VERSION}" &&\ +git push --tags +``` diff --git a/Makefile b/Makefile index dddcaa8..ff824bd 100644 --- a/Makefile +++ b/Makefile @@ -80,7 +80,7 @@ outdated: @echo Show outdated dependencies $(POETRY_CMD) show --outdated -# Executing and publishing +# Executing run-venv: @echo Execute package directly in virtual environment @@ -91,10 +91,3 @@ install-run: python -m pip install --upgrade . @echo --- Note: The next command might fail before you reload your shell my_module_cli - -publish: - @echo Release version $(VERSION) - git tag -a $(VERSION) -m "Version $(VERSION)" - git push --tags -# Uncomment the following line to integrate with pypi publishing -# $(POETRY_CMD) publish