From d727e62e57993bb6b905544eb22c36d19f350a0c Mon Sep 17 00:00:00 2001 From: Konstantin Klepikov Date: Thu, 1 Dec 2022 17:06:25 +0200 Subject: [PATCH] fix version bump for release --- .github/workflows/github-release.yml | 2 +- Makefile | 6 ++++++ README.md | 5 ++++- bgameb/newsfragments/218.bugfix | 3 +++ 4 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 bgameb/newsfragments/218.bugfix diff --git a/.github/workflows/github-release.yml b/.github/workflows/github-release.yml index 2eb8dad..b02dc68 100644 --- a/.github/workflows/github-release.yml +++ b/.github/workflows/github-release.yml @@ -35,6 +35,6 @@ jobs: with: tag_name: ${{ steps.get-latest-tag.outputs.tag }} body: | - [CHANGELOG](https://github.com/${{ github.repository }}/blob/main/CHANGELOG.rst). + [CHANGELOG](https://github.com/${{ github.repository }}/blob/main/CHANGELOG.rst) draft: false prerelease: false diff --git a/Makefile b/Makefile index dbd265b..7308f66 100644 --- a/Makefile +++ b/Makefile @@ -9,10 +9,16 @@ proj-doc: sphinx-apidoc -o docs/source bgameb $(MAKE) -C ./docs html +draft: + # read release notes draft + towncrier build --draft + release: @read -p "Enter final version as X.Y.Z:" bump; \ python -m incremental.update bgameb --newversion=$$bump; \ towncrier build --yes; \ + sphinx-apidoc -o docs/source bgameb; \ + $(MAKE) -C ./docs html; \ git add .; \ git status; \ git commit -m "release $$bump"; \ diff --git a/README.md b/README.md index fb9cf43..e3fd05f 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,9 @@ Available fragmet naming: - .removal: Signifying a deprecation or removal of public API. - .misc: A ticket has been closed, but it is not of interest to users. -`make release` - to bump version, build changelog, commit, push tags and changes. You can use `towncrier build --draft` to check changelog output before release. +`make draft` - to check changelog output before release. + +`make release` - to bump version, build changelog, commit, push tags and changes. \* for version management are used [incremental](https://github.com/twisted/incremental) and [towncrier](https://pypi.org/project/towncrier/) for changelog +\* project based on [dataclasses-json](https://github.com/lidatong/dataclasses-json) diff --git a/bgameb/newsfragments/218.bugfix b/bgameb/newsfragments/218.bugfix new file mode 100644 index 0000000..86c4800 --- /dev/null +++ b/bgameb/newsfragments/218.bugfix @@ -0,0 +1,3 @@ +#218: + * added ``make draft`` to makefile and now with ``make release`` is bulded doc after version bump but before taged and push to github + * -> \ No newline at end of file