ci(Versioning): semantic release setup and github action workflow

Author: ibresslerBAM

.github/workflows/ci-cd.yml

@@ -0,0 +1,22 @@
+name: CI-CD
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  # check if everything works first
+  tests:
+    uses: ./.github/workflows/tests.yml
+
+  # make a new version next, release or prerelease
+  release:
+    needs: [tests]
+    uses: ./.github/workflows/release.yml

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+
+# Controls when the action will run.
+on:
+  workflow_call:
+
+jobs:
+  # make a new version first, release or prerelease
+  release:
+    # Only run this job if new work is pushed to "main"
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checking out the repo
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Setup git user
+        shell: sh
+        run: |
+          git config user.name "${GITHUB_ACTOR}"
+          git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+
+      - name: Setting up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          cache: pip
+          cache-dependency-path: requirements.txt
+
+      - name: Determine the next version number
+        env:
+          GH_TOKEN: {{'${{ secrets.GITHUB_TOKEN }}'}}
+        shell: sh
+        run: |
+          set -x
+          python -m pip install python-semantic-release
+          NEWVER=$(semantic-release version --print)
+          # version number updates with regexp which is not supported by
+          # semantic_release.version_variables in pyproject.toml
+          sed -i -e "s/v\([0-9]\+\.\)\{3\}/v$NEWVER./" README.md
+          git add README.md
+          # creates a release only if there are relevant changes/commits starting with 'fix/feat()'
+          semantic-release version

.github/workflows/tests.yml

@@ -0,0 +1,50 @@
+name: Tests
+
+# Controls when the action will run.
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+  workflow_call:
+
+jobs:
+  # defining this job separately allows to refer to it later as job.needs dependency
+  tests:
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        python_arch: ['x64']
+        python:
+          - 3.12
+        # os: ['ubuntu', 'windows', 'macos']
+        os: ['ubuntu']
+    env:
+      PYTHON: "${{ join(matrix.python, '.') }}"  # e.g. '3.11'
+      TOX_ENV: "${{ format('{0}{1}', 'py', join(matrix.python, '')) }}"  # e.g. 'py311'
+    runs-on: "${{ format('{0}-latest', matrix.os) }}"
+    name: '"Test py-${{ join(matrix.python, \'.\') }} (${{ matrix.os }})"'
+    steps:
+
+      - name: Checking out the repo
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Setting up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON }}
+          architecture: ${{ matrix.python_arch }}
+          cache: pip
+          cache-dependency-path: "requirements.txt"
+
+      - name: Show installed package details
+        shell: sh
+        run: |
+          pip list --format=freeze
+
+      - name: Run tests
+        shell: sh
+        run: |
+          echo copier copy yapy-copier-template my-test-project

README.md

@@ -1,4 +1,4 @@
-# yapy-copier-template
+# yapy-copier-template (v1.0.0)
 
 Yet Another Python [Copier][1] template for a Python modules and applications focussing on data science, processing and analysis.
 

semantic-release.toml

@@ -0,0 +1,17 @@
+[semantic_release]
+version_variables = [                        # version location
+]
+
+[semantic_release.remote]
+ignore_token_for_push = true
+
+[semantic_release.commit_parser_options] # same as in the template itself
+allowed_tags = ["build", "chore", "ci", "docs", "feat", "enh", "fix", "perf", "style", "refactor", "test"]
+minor_tags = ["feat", "enh"]
+patch_tags = ["fix", "perf"]
+
+[semantic_release.changelog]
+exclude_commit_patterns = ["chore", ".*\\bGHA\\b.*", ".*\\b[gG][hH] actions?\\b.*"]
+
+[semantic_release.publish]
+upload_to_vcs_release = false