17 python release

.github/actions/python-install/action.yml

@@ -0,0 +1,80 @@
+name: Setup Python Venv
+
+# Reusable workflow for Python projects that checks out repo and installs with Poetry
+
+
+inputs:
+  python-version:
+    description: A Python version to use
+    required: true
+    type: string
+  poetry-version:
+    description: The poetry version to use
+    required: false
+    type: string
+  working-directory:
+    description: The working directory
+    required: false
+    type: string
+    default: .
+  delete-poetry-lock:
+    description: Delete poetry lock file in order to test against newer versions
+    required: false
+    type: boolean
+    default: false
+
+runs:
+  using: "composite"
+  steps:
+
+
+    #----------------------------------------------
+    #       delete poetry.lock file in order to run tests against newer versions
+    #----------------------------------------------
+    - name: Delete poetry.lock file
+      if: ${{ inputs.delete-poetry-lock == 'true' }}
+      shell: bash
+      working-directory: ${{ inputs.working-directory }}
+      run: |
+        rm ./poetry.lock
+        echo "::Warning tile=poetry.lock::Poetry.lock is deleted in this workflow run. You might have to do this too when reproducing build errors."
+
+    #----------------------------------------------
+    #       install Python
+    #----------------------------------------------
+    - uses: actions/setup-python@v5
+      id: pythonInstallStep
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    #----------------------------------------------
+    #       install Poetry
+    #----------------------------------------------
+    - name: Install and configure Poetry
+      uses: GNS-Science/install-poetry@main
+      with:
+        version: ${{ inputs.poetry-version }}
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+        installer-parallel: true
+
+    #----------------------------------------------
+    #       load cached venv if cache exists
+    #----------------------------------------------
+    - name: Load cached venv
+      id: cached-poetry-dependencies
+      if: ${{ inputs.delete-poetry-lock == 'false' }}
+      uses: actions/cache@v4
+      with:
+        path: ${{ inputs.working-directory }}/.venv
+        key: venv-${{ runner.os }}-${{ steps.pythonInstallStep.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}-python-run-tests
+
+    #----------------------------------------------
+    #        install dependencies if cache does not exist
+    #----------------------------------------------
+    - name: Install dependencies
+      shell: bash
+      if: inputs.delete-poetry-lock || steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      working-directory: ${{ inputs.working-directory }}
+      run: 
+        poetry install --no-interaction --no-root --with dev --all-extras

.github/workflows/python-deploy-docs.yml

@@ -0,0 +1,86 @@
+name: Python Deploy Docs
+
+# Publishes documentation for a python package to GitHub pages. Uses `mkdocs` for building documentation. Would commonly
+# be one of two jobs along with with Python Release Workflow in a repo workflow triggered by e.g. tagging a version.
+
+on:
+  workflow_call:
+    inputs:
+        python-version:
+            description: The python version to use
+            required: true
+            type: string
+            default: "3.10"
+        poetry-version:
+            description: The poetry version to use
+            required: false
+            type: string
+            default: "latest"
+        working-directory:
+            description: The working directory
+            required: false
+            type: string
+            default: .
+        timeout-minutes:
+          description: Maximum runtime in minutes
+          required: false
+          type: number
+          default: 10
+
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+        name: github-pages
+        url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    defaults:
+        run:
+            working-directory: ${{ inputs.working-directory }}
+
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - name: install_package
+        uses: GNS-Science/nshm-github-actions/.github/actions/python-install@main
+        with:
+          python-version: ${{ inputs.python-version }}
+          poetry-version: ${{ inputs.poetry-version }}
+          working-directory: ${{ inputs.working-directory }}
+
+        #----------------------------------------------
+        # build documentation
+        #----------------------------------------------
+      - name: build documentation
+        run: |
+          poetry run mkdocs build
+
+        #----------------------------------------------
+        # package and upload artifact for deployment to GitHub Pages 
+        #----------------------------------------------
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: ${{ inputs.working-directory }}/site
+
+
+        #----------------------------------------------
+        # deploy page
+        #----------------------------------------------
+      - name: Deploy Docs to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/python-release.yml

@@ -0,0 +1,111 @@
+name: Python Release
+
+# Creates a GitHub release and publishes the package to PyPI. Would commonly be one of two jobs along
+# with with Python Deploy Docs in a repo workflow triggered by e.g. tagging a version.
+#
+# Requires the secret `PYPI_API_TOKEN`.
+
+on:
+  workflow_call:
+    inputs:
+        python-version:
+            description: The python version to use
+            required: true
+            type: string
+            default: "3.10"
+        poetry-version:
+            description: The poetry version to use
+            required: false
+            type: string
+            default: "latest"
+        working-directory:
+            description: The working directory
+            required: false
+            type: string
+            default: .
+        timeout-minutes:
+          description: Maximum runtime in minutes
+          required: false
+          type: number
+          default: 10
+
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    defaults:
+        run:
+            shell: bash
+            working-directory: ${{ inputs.working-directory }}
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - name: install_package
+        uses: GNS-Science/nshm-github-actions/.github/actions/python-install@main
+        with:
+          python-version: ${{ inputs.python-version }}
+          poetry-version: ${{ inputs.poetry-version }}
+          working-directory: ${{ inputs.working-directory }}
+
+        #----------------------------------------------
+        #       get version
+        #----------------------------------------------
+      - name: Get version from tag
+        id: tag_name
+        run: |
+          echo name=current_version::${GITHUB_REF#refs/tags/v} >> "$GITHUB_OUTPUT"
+        shell: bash
+
+        #----------------------------------------------
+        #       get changelog entry
+        #----------------------------------------------
+      - name: Get Changelog Entry
+        id: changelog_reader
+        uses: GNS-Science/changelog-reader-action@master
+        with:
+          validation_depth: 10
+          version: ${{ steps.tag_name.outputs.current_version }}
+          path: ${{ inputs.working-directory }}/CHANGELOG.md
+
+        #----------------------------------------------
+        # build wheels and tarball
+        #----------------------------------------------
+      - name: Build wheels and source tarball
+        run: >-
+          poetry build
+
+      - name: show temporary files
+        run: >-
+          ls -l
+
+        #----------------------------------------------
+        # create GitHub release
+        #----------------------------------------------
+      - name: create github release
+        id: create_release
+        uses: GNS-Science/action-gh-release@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          body: ${{ steps.changelog_reader.outputs.changes }}
+          files: ${{ inputs.working-directory }}/dist/*.whl
+          draft: false
+          prerelease: false
+
+        #----------------------------------------------
+        # publish to PyPI
+        #----------------------------------------------
+      - name: publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          skip-existing: true

.github/workflows/python-run-tests.yml

@@ -78,57 +78,15 @@ jobs:
       PYTHON: ${{ matrix.python-version }}
     steps:
 
-      #----------------------------------------------
-      #       check out repo
-      #----------------------------------------------
       - uses: actions/checkout@v4
 
-      #----------------------------------------------
-      #       delete poetry.lock file in order to run tests against newer versions
-      #----------------------------------------------      
-      - name: Delete poetry.lock file
-        if: ${{ inputs.delete-poetry-lock }}
-        run: |
-          rm ./poetry.lock
-          echo "::Warning tile=poetry.lock::Poetry.lock is deleted in this workflow run. You might have to do this too when reproducing build errors."
-
-      #----------------------------------------------
-      #       install Python
-      #----------------------------------------------
-      - uses: actions/setup-python@v5
-        id: pythonInstallStep
+      - name: install_package
+        uses: GNS-Science/nshm-github-actions/.github/actions/python-install@main
         with:
           python-version: ${{ matrix.python-version }}
-
-      #----------------------------------------------
-      #       install Poetry
-      #----------------------------------------------
-      - name: Install and configure Poetry
-        uses: GNS-Science/install-poetry@main
-        with:
-          version: ${{ inputs.poetry-version }}
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          installer-parallel: true
-
-      #----------------------------------------------
-      #       load cached venv if cache exists
-      #----------------------------------------------
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        if: ${{ ! inputs.delete-poetry-lock }}
-        uses: actions/cache@v4
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ steps.pythonInstallStep.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}-python-run-tests
-
-      #----------------------------------------------
-      #        install dependencies if cache does not exist
-      #----------------------------------------------
-      - name: Install dependencies
-        if: inputs.delete-poetry-lock || steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: 
-          poetry install --no-interaction --no-root --with dev --all-extras
+          poetry-version: ${{ inputs.poetry-version }}
+          working-directory: ${{ inputs.working-directory }}
+          delete-poetry-lock: ${{ inputs.delete-poetry-lock }}
 
       #----------------------------------------------
       #        Install tox-gh-actions. 

README.MD

@@ -23,3 +23,38 @@ jobs:
       python-versions: "['3.9', '3.10', '3.11']"
     secrets: inherit
 ```
+
+### [Python Release Workflow](./.github/workflows/python-release.yml)
+
+Creates a GitHub release and publishes the package to PyPI. Would commonly be one of two jobs along with with Python Deploy Docs in a repo workflow triggered by e.g. tagging a version.
+
+Requires the secret `PYPI_API_TOKEN`.
+
+Example use:
+
+```yml
+jobs:
+  release-and-distribute:
+    uses:  GNS-Science/nshm-github-actions/.github/workflows/python-release.yml@main
+    with:
+      python-version:  '3.12'
+    secrets: inherit
+```
+
+
+### [Python Deploy Docs Workflow](./.github/workflows/python-deploy-docs.yml)
+
+Publishes documentation for a python package to GitHub pages. Uses `mkdocs` for building documentation. Would commonly be one of two jobs along with with Python Release Workflow in a repo workflow triggered by e.g. tagging a version.
+
+Requires that the branch or tag you want to use has permission to do so in the `github-pages` environment; see [GitHub documentation](https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments).
+
+Example use:
+
+```yml
+jobs:
+  deploy-docs:
+    uses:  GNS-Science/nshm-github-actions/.github/workflows/python-deploy-docs.yml@main
+    with:
+      python-version:  '3.12'
+    secrets: inherit
+```

samplePythonProject/pyproject.toml

@@ -11,7 +11,7 @@ packages = [
 ]
 
 dependencies = [
-    "pytest (>=8.3.5,<9.0.0)"
+    "pytest (>=8.3.5,<9.0.0)",
 ]
 
 [tool.poetry.dependencies]