Merge pull request #107 from kmike/towncrier

Use towncrier to manage changelog

.github/workflows/automerge.yml

@@ -10,6 +10,7 @@ on:
       - 'Run tests'
       - 'Run tests on macos'
       - 'Test build package'
+      - 'Run test commands'
 
 jobs:
   merge-me:

.github/workflows/pr-check.yml

@@ -0,0 +1,27 @@
+name: Run test commands
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+#  bump:
+#    runs-on: ubuntu-latest
+#    steps:
+#      - name: Check out repository
+#        uses: actions/checkout@v3
+#      - uses: fizyk/actions-reuse/.github/actions/pipenv@v1.6.3
+#        with:
+#          python-version: "3.11"
+#          pipenv-install-options: "--skip-lock"
+#          command: tbump --dry-run --only-patch $(pipenv run tbump current-version)"-x"
+  towncrier:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    steps:
+      - uses: fizyk/actions-reuse/.github/actions/pipenv@v1.6.3
+        with:
+          python-version: "3.11"
+          pipenv-install-options: "--skip-lock"
+          command: towncrier check --compare-with origin/main
+          fetch-depth: 0

CHANGES.rst

@@ -1,6 +1,8 @@
 CHANGELOG
 =========
 
+.. towncrier release notes start
+
 0.6.2
 ----------
 

Pipfile

@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+towncrier = "==22.8"
+
+[requires]
+python_version = "3.9"

newsfragments/.gitignore

@@ -0,0 +1 @@
+!.gitignore

newsfragments/107.misc.rst

@@ -0,0 +1 @@
+Use towncrier as a changelog management tool.

pyproject.toml

@@ -2,6 +2,28 @@
 requires = ["setuptools >= 40.6.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[tool.towncrier]
+directory = "newsfragments"
+single_file=true
+filename="CHANGES.rst"
+issue_format="`#{issue} <https://https://github.com/kmike/port-for/issues/{issue}>`_"
+
+[tool.towncrier.fragment.feature]
+name = "Features"
+showcontent = true
+
+[tool.towncrier.fragment.bugfix]
+name = "Bugfixes"
+showcontent = true
+
+[tool.towncrier.fragment.break]
+name = "Breaking changes"
+showcontent = true
+
+[tool.towncrier.fragment.misc]
+name = "Miscellaneus"
+showcontent = true
+
 [tool.black]
 line-length = 80
 target-version = ['py38']