Merge pull request #30 from dls-controls/changelog

Make github changelog canonical

Author: coretl

.github/workflows/code.yml

@@ -23,7 +23,7 @@ jobs:
         run: flake8
 
   build:
-    name: ${{ matrix.os }}/${{ matrix.python }}
+    name: build/${{ matrix.os }}/${{ matrix.python }}
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -106,22 +106,29 @@ jobs:
           name: ${{ matrix.os }}/${{ matrix.python }}
           directory: dist
 
-  upload_pypi:
+  release:
     needs: [build]
     runs-on: ubuntu-latest
-    # upload to PyPI on every tag
+    # upload to PyPI and make a release on every tag
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     steps:
       - uses: actions/download-artifact@v2
         with:
           name: dist
           path: dist
 
-      - name: Install Python Dependencies
-        run: pip install twine
+      - 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
+        with:
+          files: dist/*
+          body: See [Changelog](CHANGELOG.rst) for more details
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Publish to PyPI
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.pypi_token }}
-        run: twine upload dist/*
+        run: pipx run twine upload dist/*

.github/workflows/docs.yml

@@ -44,7 +44,7 @@ jobs:
         # Only master and tags are published
         if: "${{ github.repository_owner == 'dls-controls' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags')) }}"
         # We pin to the SHA, not the tag, for security reasons.
-        # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
+        # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
         uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.rst

@@ -66,12 +66,10 @@ You can build the docs from the project directory by running::
 Release Process
 ---------------
 
-To make a new release, please go through the following checklist:
+To make a new release, please follow this checklist:
 
 - Choose a new PEP440 compliant release number
-- Git tag the version with a message summarizing the changes
+- Add a release note in CHANGELOG.rst
+- Git tag the version
 - Push to github and the actions will make a release on pypi
-- Push to internal gitlab but do not release from there
-- Run ``dls-py3 download-one-dependency softioc <release>``
-- Run ``cp Pipfile.lock /dls_sw/work/python3/RHEL7-x86_64/distributions/softioc-<release>.Pipfile.lock``
-- Run ``dls-release.py -a python3ext softioc <release>``
+- Push to internal gitlab and do a dls-release.py of the tag

README.rst

@@ -13,6 +13,7 @@ asyncio for concurrency. PVs are served over Channel Access and PVAccess.
 PyPI           ``pip install softioc``
 Source code    https://github.com/dls-controls/pythonSoftIOC
 Documentation  https://dls-controls.github.io/pythonSoftIOC
+Changelog      https://github.com/dls-controls/pythonSoftIOC/blob/master/CHANGELOG.rst
 ============== ==============================================================
 
 A simple example of the use of this library:

docs/_templates/layout.html

@@ -9,7 +9,9 @@
   {{ super() }}
   <!-- Include Index in the sidebar -->
   <!-- https://stackoverflow.com/a/37843854 -->
-  <a href="{{pathto('genindex.html', 1)}}">Index</a>
+  <a href="{{ pathto('genindex.html', 1) }}">Index</a>
+  <!-- Include link to changelog too -->
+  <a href="https://github.com/dls-controls/{{ project }}/blob/master/CHANGELOG.rst">Changelog</a>
   <!-- Add versions for selected branches + tags -->
   <p class="caption"><span class="caption-text">Versions</span></p>
   <ul id="versions"/>

docs/index.rst

@@ -79,7 +79,6 @@ Table Of Contents
     :maxdepth: 1
 
     reference/api
-    reference/changelog
     reference/contributing
 
 * :ref:`genindex`