Add workflows to publish to PyPI and GH Pages (#4)

* Add workflow to publish to PyPI
* Add workflow to publish docs to GitHub pages
* Upgrade mkdocs
* Bump version

Author: cre-os

.github/workflows/publish-to-gh-pages.yml

@@ -0,0 +1,31 @@
+name: Publish documentation website to GitHub pages
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mkdocstrings[python]
+      - run: mkdocs gh-deploy --force

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,76 @@
+name: Publish releases to PyPI and publish
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/xml2db
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/xml2db
+
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xml2db"
-version = "0.9.4"
+version = "0.10.0"
 authors = [
   { name="Commission de régulation de l'énergie", email="[email protected]" },
 ]
@@ -23,7 +23,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-docs = ["mkdocs-material==9.5.14", "mkdocstrings[python]==0.24.1"]
+docs = ["mkdocs-material==9.5.23", "mkdocstrings-python==1.10.2"]
 tests = ["pytest>=7.0"]
 
 [project.urls]

requirements.txt

@@ -7,20 +7,21 @@ elementpath==4.4.0
 exceptiongroup==1.2.0
 ghp-import==2.1.0
 greenlet==3.0.3
-griffe==0.42.1
+griffe==0.45.0
 idna==3.6
 iniconfig==2.0.0
 Jinja2==3.1.3
 lxml==5.1.0
 Markdown==3.5.2
 MarkupSafe==2.1.5
 mergedeep==1.3.4
-mkdocs==1.5.3
+mkdocs==1.6.0
 mkdocs-autorefs==1.0.1
-mkdocs-material==9.5.14
+mkdocs-get-deps==0.2.0
+mkdocs-material==9.5.23
 mkdocs-material-extensions==1.3.1
-mkdocstrings==0.24.1
-mkdocstrings-python==1.9.0
+mkdocstrings==0.25.1
+mkdocstrings-python==1.10.2
 packaging==24.0
 paginate==0.5.6
 pathspec==0.12.1
@@ -42,6 +43,4 @@ tomli==2.0.1
 typing_extensions==4.10.0
 urllib3==2.2.1
 watchdog==4.0.0
-# Editable Git install with no remote (xml2db==0.9.4)
--e d:\code\xml2db-os
 xmlschema==3.1.0