Merge pull request #28 from hydrologie/disable-github-docs

Disable GitHub docs, Add deployment safeguards

.github/workflows/bump-version.yml

@@ -10,7 +10,9 @@ on:
       - .github/**.yml
       - .gitignore
       - .pre-commit-config.yaml
+      - .readthedocs.yml
       - .yamllint.yaml
+      - .zenodo.json
       - AUTHORS.rst
       - CONTRIBUTING.rst
       - HISTORY.rst

.github/workflows/publish-pypi.yml

@@ -8,6 +8,7 @@ on:
 jobs:
   build-n-publish-pypi:
     name: Build and publish Python 🐍 distributions 📦 to PyPI
+    environment: production
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/tag-testpypi.yml

@@ -3,11 +3,12 @@ name: Publish Python 🐍 distributions 📦 to TestPyPI
 on:
   push:
     tags:
-      - '*'
+      - 'v*.*.*'
 
 jobs:
   build-n-publish-testpypi:
     name: Build and publish Python 🐍 distributions 📦 to TestPyPI
+    environment: staging
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

HISTORY.rst

@@ -9,7 +9,7 @@ Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Gabriel R
 Announcements
 ^^^^^^^^^^^^^
 * Support for Python3.8 and lower has been dropped. (:pull:`11`).
-* `xHydro` now hosts its documentation on `Read the Docs <https://xhydro.readthedocs.io/en/latest/>`_. (:pull:`26`).
+* `xHydro` now hosts its documentation on `Read the Docs <https://xhydro.readthedocs.io/en/latest/>`_. (:issue:`22`, :pull:`26`).
 
 New features and enhancements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -34,6 +34,7 @@ Internal changes
     * Some sphinx extensions have been added/enabled (sphinx-codeautolink, sphinx-copybutton).
     * Automated testing with tox now updated to use v4.0+ conventions.
     * Removed all references to travis.ci.
+* Deployments to TestPyPI and PyPI are now run using GitHub Workflow Environments as a safeguarding mechanism. (:pull:`28`).
 
 0.1.2 (2023-05-10)
 ------------------