towncrier for the changelog

.github/workflows/upload-pypi-source.yml

@@ -28,7 +28,6 @@ jobs:
       uses: actions/checkout@v3
       with:
         fetch-depth: 0
-        submodules: recursive
 
     - uses: Chia-Network/actions/setup-python@main
       name: Install Python
@@ -50,6 +49,10 @@ jobs:
         python -m pip install --upgrade pip setuptools wheel
         python -m pip install .[dev]
 
+    - name: Require change fragment
+      run: |
+        towncrier check --compare-with "origin/${{ github.event.pull_request.base.ref }}"
+
     - name: Lint source with black
       run: |
         black --check --diff .
@@ -83,3 +86,40 @@ jobs:
         TWINE_NON_INTERACTIVE: 1
         TWINE_PASSWORD: ${{ secrets.pypi_password }}
       run: twine upload --non-interactive --skip-existing --verbose 'dist/*'
+
+  build_changelog:
+    name: Build changelog
+    runs-on: [ubuntu-latest]
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - uses: Chia-Network/actions/setup-python@main
+      name: Install Python
+      with:
+        python-version: '3.8'
+
+    - uses: ./.github/actions/install
+      with:
+        python-version: '3.8'
+        development: true
+
+    - uses: chia-network/actions/activate-venv@main
+
+    - name: Create single version changlog summary
+      run: |
+        towncrier build --yes --draft >> $GITHUB_STEP_SUMMARY
+
+    - name: Build changelog
+      run: |
+        towncrier build --yes
+
+    - name: Publish changelog artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: changelog
+        path: CHANGELOG.md
+        if-no-files-found: error

CHANGELOG.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project does not yet adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 for setuptools_scm/PEP 440 reasons.
 
+<!-- towncrier start string -->
 ## 1.6.1 Chia blockchain 2022-11-03
 
 ### Added

changes/.gitignore

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

changes/template.md

@@ -0,0 +1,13 @@
+## {{ versiondata.version }} Chia blockchain {{ versiondata.date }}
+
+{% for section, _ in sections.items() %}
+{% for category, val in definitions.items() if category in sections[section]%}
+### {{ definitions[category]['name'] }}
+
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+- {{ text }}
+{% endfor %}
+{% endif %}
+{% endfor %}
+{% endfor %}

changes/x.added

@@ -0,0 +1 @@
+Started using towncrier.  https://towncrier.readthedocs.io/en/stable/

setup.py

@@ -63,6 +63,7 @@
     "aiohttp_cors",  # For blackd
     "ipython",  # For asyncio debugging
     "pyinstaller==5.3",
+    "towncrier",
     "types-aiofiles",
     "types-cryptography",
     "types-pkg_resources",

towncrier.toml

@@ -0,0 +1,29 @@
+[tool.towncrier]
+directory = "changes"
+filename = "CHANGELOG.md"
+package = "chia"
+start_string = "<!-- towncrier start string -->"
+template = "changes/template.md"
+#title_format = "{version} {name} {project_date}"
+#underlines = " "
+
+[tool.towncrier.fragment.added]
+name ="Added"
+
+[tool.towncrier.fragment.changed]
+name = "Changed"
+
+[tool.towncrier.fragment.deprecated]
+name = "Deprecated"
+
+[tool.towncrier.fragment.removed]
+name = "Removed"
+
+[tool.towncrier.fragment.fixed]
+name = "Fixed"
+
+[tool.towncrier.fragment.security]
+name = "Security"
+
+[tool.towncrier.fragment.misc]
+showcontent = false