chore: tweak release notes (#36)

Author: Joris Conijn

.github/workflows/release.yml

@@ -25,6 +25,16 @@ jobs:
         run: make install
       - name: Run check
         run: make build
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release v${{ steps.vars.outputs.version }}
+          draft: false
+          prerelease: false
       - name: Upload Release Asset
         id: upload-release-asset
         uses: actions/upload-release-asset@v1

CONTRIBUTING.md

@@ -17,18 +17,21 @@ reported the issue. Please try to include as much information as you can.
 ## Releases
 
 First you will need to update the `version` in the [`pyproject.toml`](./pyproject.toml) file. Next you need to merge the
-change to the `main` branch using a pull request.
+change to the `develop` branch using a pull request.
+
+Lookup the generated release notes, they are listed as draft. Copy them to a temporary file for later use.
 
 Then you need to create a new release. You can do this by creating a tag and push it to the remote:
 
- ```bash
- git tag v$(awk '/version/{print $NF}'  pyproject.toml | sed 's/\"//g')
- git push --tags
- ```
+```bash
+git tag v$(awk '/version/{print $NF}'  pyproject.toml | sed 's/\"//g')
+git push --tags
+```
 
 This will trigger the GitHub Actions [`release`](.github/workflows/release.yml) workflow. When the release process is
 done. You need to create a pull request from `develop` to `main` and merge it.
 
-Then you need to the releases section on GitHub and publish the new release.
+Then you need to the releases section on GitHub and update the new release. Go to the releases section on GitHub and
+update the new release with the previously stored release notes.
 
 All done!