Merge PR #136: Added GitHub Actions workflow to Publish on PyPI

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and Publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist build
+        python setup.py sdist bdist_wheel
+        # twine upload --repository testpypi dist/*
+        twine upload dist/*

docs/release.md

@@ -1,6 +1,20 @@
 # Release Instructions
 
-```bash
-python setup.py sdist build
-python setup.py sdist upload
-```
+This list is supposed to make sure we do not forget any important steps during
+release.
+
+1. Check and update issue tracker for issues associated with current milestone
+
+2. Make sure all desired changes are merged with `master`.
+
+3. Create release-prep branch and update CHANGELOG.md with all elements missing
+
+4. Prepare a release on GitHub with: https://github.com/smarr/ReBench/releases/new
+   The content is normally just the last part of the CHANGELOG.md
+
+5. Bump the version https://github.com/smarr/ReBench/blob/master/rebench/__init__.py
+
+6. Push the branch, let CI test a last time
+
+7. If everything looks good, merge, and tag the release using the GitHub feature
+   If GitHub actions works correctly, it will publish the release on pip.

setup.py

@@ -23,9 +23,14 @@
 from setuptools import setup, find_packages
 from rebench import __version__ as rebench_version
 
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
 setup(name='ReBench',
       version=rebench_version,
       description='Execute and document benchmarks reproducibly.',
+      long_description=long_description,
+      long_description_content_type="text/markdown",
       author='Stefan Marr',
       author_email='[email protected]',
       url='https://github.com/smarr/ReBench',