CI: Add PyPi publish workflow (#44)

Author: aaronsteers

.github/workflows/pypi_publish.yml

@@ -0,0 +1,43 @@
+name: Publish to PyPi
+
+on:
+  push:
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - uses: hynek/build-and-inspect-python-package@v2
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build]
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write  # Needed to upload artifacts to the release
+    environment:
+      name: PyPi
+      url: https://pypi.org/p/airbyte
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+    - uses: actions/download-artifact@v4
+      with:
+        name: Packages
+        path: dist
+    - name: Upload wheel to release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: dist/*.whl
+        tag: ${{ github.ref }}
+        overwrite: true
+        file_glob: true
+
+    - name: Publish
+      uses: pypa/gh-action-pypi-publish@v1.8.11

CONTRIBUTING.md

@@ -25,10 +25,17 @@ Documentation pages will be generated in the `docs/generated` folder. The `test_
 
 ## Release
 
-- In your PR:
-  - Bump the version in `pyproject.toml`
-  - Add a changelog entry to the table below
-- Once the PR is merged, go to Github and trigger the `Publish PyAirbyte Manually` workflow. This will publish the new version to PyPI.
+Releases are published automatically to PyPi in response to a "published" event on a GitHub Release Tag.
+
+To publish to PyPi, simply [create a GitHub Release](https://github.com/airbytehq/PyAirbyte/releases/new) with the correct version. Once you publish the release on GitHub it will automatically trigger a PyPi publish workflow in GitHub actions.
+
+> **Warning**
+> 
+> Be careful - "Cmd+Enter" will not 'save' but will instead 'publish'. (If you want to save a draft, use the mouse. 😅)
+
+> **Note**
+> 
+> There is no version to bump. Version is calculated during build and publish, using the [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning) plugin.
 
 ## Versioning
 

README.md

@@ -1,6 +1,6 @@
 # PyAirbyte
 
-PyAirbyte is a library that allows to run Airbyte syncs embedded into any Python application, without requiring connectivity to a hosted Airbyte instance.
+PyAirbyte brings the power of Airbyte to every Python developer.
 
 ## Secrets Management
 

pyproject.toml

@@ -1,11 +1,17 @@
 [tool.poetry]
 name = "airbyte"
 description = "PyAirbyte"
-version = "0.1.0"
 authors = ["Airbyte <contact@airbyte.io>"]
 readme = "README.md"
 packages = [{include = "airbyte"}]
 
+# This project uses dynamic versioning
+# https://github.com/mtkennerly/poetry-dynamic-versioning
+version = "0.0.0"
+
+[tool.poetry-dynamic-versioning]
+enable = true
+
 [tool.poetry.dependencies]
 python = "^3.9"
 
@@ -51,8 +57,8 @@ airbyte-source-faker = "^6.0.0"
 tomli = "^2.0"
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"
 
 [tool.pytest.ini_options]
 markers = [