added github workflows tests.yml

Author: root

.github/workflows/tests.yml

@@ -0,0 +1,107 @@
+# Regular tests
+#
+# Use this to ensure your tests are passing on every push and PR (skipped on
+# pushes which only affect documentation).
+#
+# You should make sure you run jobs on at least the *oldest* and the *newest*
+# versions of python that your codebase is intended to support.
+
+name: tests
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+
+jobs:
+  test:
+    timeout-minutes: 45
+    defaults:
+      run:
+        shell: bash
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-13, windows-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python-version }}
+
+    steps:
+      - name: Set OS Environment Variables (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          echo 'ACTIVATE_PYTHON_VENV=.venv/scripts/activate' >> $GITHUB_ENV
+
+      - name: Set OS Environment Variables (not Windows)
+        if: runner.os != 'Windows'
+        run: |
+          echo 'ACTIVATE_PYTHON_VENV=.venv/bin/activate' >> $GITHUB_ENV
+
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Cache $HOME/.local # Significantly speeds up Poetry Install
+        uses: actions/cache@v4
+        with:
+          path: ~/.local
+          key: dotlocal-${{ runner.os }}-${{matrix.python-version}}-${{ hashFiles('.github/workflows/tests.yaml') }}
+
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: false # Currently there seems to be some race-condition in windows
+
+      - name: Install library
+        run: poetry install --no-interaction
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit/
+          key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Pre-commit run
+        run: |
+          source ${{ env.ACTIVATE_PYTHON_VENV }}
+          pre-commit run --show-diff-on-failure --color=always --all-files
+
+      - name: Check tests folder existence
+        id: check_test_files
+        uses: andstor/file-existence-action@v3
+        with:
+          files: "tests"
+
+      - name: Run tests
+        if: steps.check_test_files.outputs.files_exists == 'true'
+        run: |
+          source ${{ env.ACTIVATE_PYTHON_VENV }}
+          make test
+          coverage report
+
+        #----------------------------------------------
+        #            make sure docs build
+        #----------------------------------------------
+      - name: Build HTML docs
+        run: |
+          source ${{ env.ACTIVATE_PYTHON_VENV }}
+          mkdocs build
+
+      - name: Upload coverage to Codecov
+        if: steps.check_test_files.outputs.files_exists == 'true'
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: unittests
+          env_vars: OS,PYTHON
+          name: Python ${{ matrix.python-version }} on ${{ runner.os }}

docs/development/building.md

@@ -182,12 +182,7 @@ To use dynamic versioning, you need to install the poetry-dynamic-versioning plu
 poetry self add poetry-dynamic-versioning
 ```
 
-After installing the plugin, you need to configure it. You can do this by adding a [tool.dynamic-versioning] section to your pyproject.toml file. Here’s an example configuration:
-
-```bash
-[tool.dynamic-versioning]
-version = { source = "git" }
-```
+### To Release a New Version
 
 1. Create and push a tag:
 ```bash

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
-requires = ["poetry-core>=1.0.0", "setuptools", "tomli"]
-build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.0.0", "setuptools", "tomli", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"
 
 [tool.poetry]
 name = "python-newtype"
@@ -41,7 +41,8 @@ python = ">=3.8,<4.0"
 typing-extensions = "*"
 
 [tool.poetry-dynamic-versioning]
-version = { source = "git" }
+enable = true
+vcs = "git"
 
 [tool.poetry.group.docs.dependencies]
 mkdocs = "*"