deployment: ensure proper version lands in tarballs

To ensure we have the proper version-strings in the tar-balls and other install forms,
we now create two commits automatically. One which contestants the release-version,
where the tag will also be places, and the one containing the dev-increment, as currently.

closes #122

Author: Cube707

.github/workflows/publish.yaml

@@ -7,80 +7,133 @@ name: Upload Python Package
 
 on:
   release:
-    types: [created]
+    types: published
 
 
 jobs:
 
-  deploy:
+  check-version:  # --------------------------------------------------------------------
     runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: get versions
+        id: get
+        run: |
+          echo "NEW_VERSION=$(echo '${{ github.ref_name }}' | cut -c2-)" | tee -a $GITHUB_OUTPUT
+          echo "OLD_VERSION=$(curl -s https://pypi.org/pypi/readchar/json |jq -r .info.version)" | tee -a $GITHUB_OUTPUT
+
+      - name: validate version
+        id: valid
+        shell: python
+        run: |
+          from sys import exit
+          from packaging import version
+          new_version = version.parse("${{ steps.get.outputs.NEW_VERSION }}")
+          old_version = version.parse("${{ steps.get.outputs.OLD_VERSION }}")
+          if not new_version > old_version:
+            print(f"::error::New version '{new_version}' not greatet than '{old_version}'")
+            exit(1)
 
+    outputs:
+      version: ${{ steps.get.outputs.NEW_VERSION }}
+
+
+  tag:  # ------------------------------------------------------------------------------
+    runs-on: ubuntu-latest
+    needs: check-version
+    permissions:
+      contents: write
+    env:
+      VERSION: ${{ needs.check-version.outputs.version }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: update pyproject.toml
+        run: sed -i -r "s/^(version = ).*$/\1\"$VERSION\"/" pyproject.toml
+
+      - name: commit version
+        env:
+          USER: github-actions[bot]
+          EMAIL: github-actions[bot]@users.noreply.github.com
+        run: git -c user.name="$USER" -c user.email="$EMAIL" commit --all -m "release v$VERSION"
+
+      - name: update tag
+        run: git tag -f "v$VERSION"
+
+      - name: push updates
+        run: git push --tags -f
+
+
+  deploy:  # ---------------------------------------------------------------------------
+    runs-on: ubuntu-latest
+    needs: tag
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0
-      - name: Set env
-        run: |
-          echo "RELEASE_TAG=${GITHUB_REF#refs/*/}" | tee -a $GITHUB_ENV
-          echo "BRANCH=$( \
-              git branch -r --contains ${GITHUB_REF} \
-              | grep -v HEAD \
-              | sed -n 's/ *origin\/\(.*\)/\1/p' \
-            )" | tee -a $GITHUB_ENV
+          ref: ${{ github.ref }}
+
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
           cache: pip
+
       - name: Install dependencies
-        run: |
-            pip install build twine
-      - name: get infos from Tag
-        run: |
-          echo "RELEASE_TAG=${RELEASE_TAG}"
-          if [[ $RELEASE_TAG =~ (([0-9]+)\.([0-9]+)\.([0-9]+))([-./]dev([0-9]+))?$ ]]
-          then
-            echo "VERSION=${BASH_REMATCH[0]}" | tee -a $GITHUB_ENV
-            echo "VERSION_MAJOR=${BASH_REMATCH[2]}" | tee -a $GITHUB_ENV
-            echo "VERSION_MINOR=${BASH_REMATCH[3]}" | tee -a $GITHUB_ENV
-            echo "VERSION_PATCH=${BASH_REMATCH[4]}" | tee -a $GITHUB_ENV
-            echo "VERSION_DEV=${BASH_REMATCH[6]}" | tee -a $GITHUB_ENV
-          else
-            echo "INVALID_TAG=True" | tee -a $GITHUB_ENV
-          fi
-      - name: Fail on invalid Tag
-        if: ${{ env.INVALID_TAG }}
-        uses: actions/github-script@v6
-        with:
-          script: core.setFailed('Invalid Tag name used with this release!')
+        run: pip install build twine
 
-      - name: Write Version to pyproject.toml
-        run: |
-          sed -i "s/version = \".*\"$/version = \"$VERSION\"/" pyproject.toml
       - name: Build sdist and bdist_wheel
-        run: |
-          python -m build
+        run: python -m build
+
       - name: publish to PyPi
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
-        run: |
-            twine upload dist/*
+        run: twine upload dist/*
+
+
+  increment:  # ------------------------------------------------------------------------
+    runs-on: ubuntu-latest
+    needs: deploy
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 3
 
-      - name: increment development version
-        if: ${{ env.VERSION_DEV }}
+      - name: get versions
+        id: get
+        shell: python
         run: |
-          v=$VERSION_MAJOR.$VERSION_MINOR.$VERSION_PATCH-dev$((VERSION_DEV+1))
-          sed -i "s/version = \".*\"$/version = \"$v\"/" pyproject.toml
-      - name: increment patch version
-        if: ${{ !env.VERSION_DEV }}
+          from sys import exit
+          from os import environ
+          from packaging import version
+          ver = version.parse("${{ github.ref_name }}")
+          if ver.dev is not None:
+            new_ver = f"{ver.base_version}-dev{ver.dev +1}"
+          else:
+            new_ver = f"{ver.major}.{ver.minor}.{ver.micro +1}-dev0"
+          with open(environ.get("GITHUB_OUTPUT"), "a") as fp:
+            towrite = f"NEW_VERSION={new_ver}"
+            print(towrite)
+            fp.write(towrite + "\n")
+
+      - name: update pyproject.toml
+        env:
+          VERSION: ${{ steps.get.outputs.NEW_VERSION }}
+        run: sed -i -r "s/^(version = ).*$/\1\"$VERSION\"/" pyproject.toml
+
+      - name: commit version
+        env:
+          USER: github-actions[bot]
+          EMAIL: github-actions[bot]@users.noreply.github.com
+        run: git -c user.name="$USER" -c user.email="$EMAIL" commit --all -m "increment version after release"
+
+      - name: push updates
         run: |
-          v=$VERSION_MAJOR.$VERSION_MINOR.$((VERSION_PATCH+1))-dev0
-          sed -i "s/version = \".*\"$/version = \"$v\"/" pyproject.toml
-      - name: commit new version-number
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          branch: ${{ env.BRANCH }}
-          create_branch: true
-          commit_message: "increment version after release"
+          git fetch origin 'refs/heads/*:refs/remotes/origin/*'
+          git push origin "HEAD:$(git log --pretty='%D' | grep -oPm1 '(?<=origin/).*')"