Skip to content

Commit

Permalink
Merge pull request #222 from KonstantinKlepikov/KonstantinKlepikov/is…
Browse files Browse the repository at this point in the history
…sue218

Konstantin klepikov/issue218
  • Loading branch information
KonstantinKlepikov authored Dec 1, 2022
2 parents 6532d2f + d727e62 commit f92a9c7
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/github-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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"; \
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
3 changes: 3 additions & 0 deletions bgameb/newsfragments/218.bugfix
Original file line number Diff line number Diff line change
@@ -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
* ->

0 comments on commit f92a9c7

Please sign in to comment.