pypi-deployment.yml

# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Deploy Python Package to PyPI & update docs

on:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Install and configure Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.5.1
          in-project: true
          prefer-active-python: true

      - name: Install dependencies
        working-directory: ./streampipes-client-python
        run: |
          poetry install --with deployment,docs --all-extras

      - name: Build package
        working-directory: ./streampipes-client-python
        run: |
          poetry version $(echo ${{ github.ref_name }} | awk -F'/' '{print $2}')  # extract release version from tag name
          poetry build
          poetry run twine check --strict dist/*

      - name: Publish package
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          user: __token__
          password: ${{ secrets.PYPI_TOKEN }}

      - name: Publish new doc version and update alias
        working-directory: ./streampipes-client-python
        run: |
          poetry run mike deploy ${GITHUB_REF##*/} latest -u --deploy-prefix ./streampipes-client-python/docs-tmp -b ${GITHUB_REF}
          git reset --hard  # undo local changes that delete generated doc files

      - name: Publish Python docs as artifact
        uses: actions/upload-artifact@v4
        with:
          name: streampipes-python-docs
          path: streampipes-client-python/docs-tmp/**/*
          retention-days: 2