Merge branch 'skeleton'

Author: coretl

.github/workflows/code.yml

@@ -103,10 +103,10 @@ jobs:
       - name: Github Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@2d72d869af3bf23602f9593a1e3fd739b80ac1eb  # v0.1.12
+        uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5  # v0.1.14
         with:
           files: dist/*
-          body: See [Changelog](CHANGELOG.rst) for more details
+          generate_release_notes: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

CONTRIBUTING.rst

@@ -82,6 +82,9 @@ When this happens:
 - Git tag the version
 - Push to github and the actions will make a release on pypi
 - Push to internal gitlab and do a dls-release.py of the tag
+- Check and edit for clarity the autogenerated GitHub release_
+
+.. _release: https://dls-controls.github.io/dls-python3-skeleton/releases
 
 Apart from this, ``master`` and ``skeleton`` should always be deployable,
 and are considered the latest release.

README.rst

@@ -12,7 +12,7 @@ Python projects.
 PyPI           ``pip install dls_python3_skeleton``
 Source code    https://github.com/dls-controls/dls-python3-skeleton
 Documentation  https://dls-controls.github.io/dls-python3-skeleton
-Changelog      https://github.com/dls-controls/dls-python3-skeleton/blob/master/CHANGELOG.rst
+Releases       https://github.com/dls-controls/dls-python3-skeleton/releases
 ============== ==============================================================
 
 It integrates the following tools:

docs/reference.rst

@@ -9,4 +9,4 @@ Practical step-by-step guides for the more experienced user.
     :caption: Reference
 
     reference/contributing
-    Changelog <https://github.com/dls-controls/dls-python3-skeleton/blob/master/CHANGELOG.rst>
+    Releases <https://github.com/dls-controls/dls-python3-skeleton/releases>