Merge pull request #179 from jooola/publish

ci: setup ci releases publishing

Author: jooola

.github/workflows/ci.yml

@@ -2,6 +2,7 @@ name: CI
 
 on:
   push:
+    tags: ["*.*.*"]
     branches: [master]
   pull_request:
     branches: [master]
@@ -42,7 +43,6 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        os: [ubuntu-latest]
         python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:
@@ -89,3 +89,28 @@ jobs:
       - run: docker-compose images
       - run: make install
       - run: make e2e
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags')
+    needs: [pre-commit, lint, test, e2e]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - run: make clean build
+
+      - uses: pypa/[email protected]
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

Makefile

@@ -14,7 +14,7 @@ $(VENV):
 
 install: $(VENV)
 	source $(VENV)/bin/activate
-	pip install --upgrade pip setuptools wheel
+	pip install --upgrade pip setuptools wheel build
 	pip install --editable .[dev]
 
 format: $(VENV)
@@ -48,5 +48,12 @@ e2e: $(VENV)
 	source $(VENV)/bin/activate
 	$(PYTEST_CMD) e2e
 
+build: $(VENV)
+	source $(VENV)/bin/activate
+	python -m build .
+
+release:
+	./scripts/release.sh
+
 clean:
-	rm -Rf $(VENV)
+	rm -Rf $(VENV) dist

README.md

@@ -113,6 +113,31 @@ Response Body: {
 >>>
 ```
 
+## Development
+
+To develop this project, start by reading the `Makefile` to have a basic understanding of the possible tasks.
+
+Install the project and the dependencies in a virtual environment:
+
+```sh
+make install
+source .venv/bin/activate
+```
+
+### Releases
+
+To release a new version, first bump the version number in `setup.py` by hand and run the release target:
+
+```sh
+make release
+```
+
+Finally, push the release commit and tag to publish them to Pypi:
+
+```sh
+git push --follow-tags
+```
+
 ## License
 
 LGPL 2.1 http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html

scripts/release.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+set -u
+
+error() {
+  echo >&2 "error: $*"
+  exit 1
+}
+
+# This scripts will:
+# - Expect the setup.py file to have new version
+# - Stash the setup.py file
+# - Check for clean state (no uncommitted changes), exit if failed
+# - Clean the project
+# - Install the project, lint and runt tests, exit if failed
+# - Unstash the pyproject version bump and commit a new Release
+# - Tag the new release
+# - Show instruction to push tags and changes to github
+
+command -v make > /dev/null || error "make command not found!"
+command -v git > /dev/null || error "git command not found!"
+command -v python3 > /dev/null || error "python3 command not found!"
+
+setup="setup.py"
+default_branch="master"
+
+[[ "$(git rev-parse --show-toplevel)" == "$(pwd)" ]] || error "please go to the project root directory!"
+[[ "$(git rev-parse --abbrev-ref HEAD)" == "$default_branch" ]] || error "please change to the $default_branch git branch!"
+
+pkg_version=$(python3 setup.py --version || error "could not determine package version in $setup!")
+git_version=$(git describe --abbrev=0 --tags || error "could not determine git version!")
+
+# No version change
+if [[ "$pkg_version" == "$git_version" ]]; then
+    echo "Latest git tag '$pkg_version' and package version '$git_version' match, edit your $setup to change the version before running this script!"
+    exit
+fi
+
+git stash push --quiet -- "$setup"
+trap 'e=$?; git stash pop --quiet; exit $e' EXIT
+
+[[ -z "$(git status --porcelain)" ]] || error "please commit or clean the changes before running this script!"
+
+git clean -xdf
+
+make lint test || error "tests failed, please correct the errors"
+
+new_tag="$pkg_version"
+release="chore: release $new_tag"
+
+git stash pop --quiet
+git add "$setup" || error "could not stage $setup!"
+git commit -m "$release" --no-verify || error "could not commit the version bump!"
+git tag "$new_tag" -a -m "$release" || error "could not tag the version bump!"
+
+echo "Run 'git push --follow-tags' in order to publish the release on Github!"