Skip to content

Library version check functionality #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
palimad wants to merge 3 commits into
base: develop
Choose a base branch
from
+527 −83
Open

Library version check functionality #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52176da
Library version check functionality
Mar 25, 2026
ef4e603
Instance specific workflows
Mar 25, 2026
69953e5
Use config variable for version management
Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
278 changes: 195 additions & 83 deletions .github/workflows/polyapi-update-python-package.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,111 +1,223 @@
name: Update python pip package

on:
push:
paths:
- "pyproject.toml"
branches:
- develop
- main
pull_request:
types: [closed]
paths:
- "pyproject.toml"
branches:
- develop
- main
- eu1
- na2

jobs:
develop-build:
build-distribution:
name: Build distribution 📦
runs-on: ubuntu-latest
if: ${{ github.ref == 'refs/heads/develop' }}
environment: dev

steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.x"


- 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@v4
with:
name: python-package-distributions
path: dist/


dev-publish-to-pypi:
name: Publish Python 🐍 distribution 📦 to PyPI
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"

- name: Install build tooling
run: python -m pip install --upgrade pip build tomli twine

- name: Build a binary wheel and a source tarball
run: python -m build

- name: Store the distribution packages
uses: actions/upload-artifact@v4
with:
name: python-package-distributions
path: dist/

- name: Resolve package version
id: pkg
shell: bash
run: |
VERSION=$(python -c "import pathlib, tomli; data = tomli.loads(pathlib.Path('pyproject.toml').read_text(encoding='utf-8')); print(data['project']['version'])")
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
echo "Resolved package version: ${VERSION}"

outputs:
package_version: ${{ steps.pkg.outputs.version }}

publish-develop:
name: Publish to PyPI and update develop client-versions
runs-on: ubuntu-latest
needs: build-distribution
environment: develop
permissions:
id-token: write
if: ${{ github.ref == 'refs/heads/develop' }}
needs: develop-build
environment:
name: dev
url: https://pypi.org/p/polyapi-python

steps:
- name: Download all dists
uses: actions/download-artifact@v4
with:
name: python-package-distributions
path: dist/

- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1

- name: Update backend client-versions
env:
BASE_URL: https://dev.polyapi.io
VERSION: ${{ needs.build-distribution.outputs.package_version }}
POLY_SUPER_ADMIN_USER_KEY: ${{ secrets.POLY_SUPER_ADMIN_USER_KEY }}
shell: bash
run: |
if [[ -z "${POLY_SUPER_ADMIN_USER_KEY}" ]]; then
echo "Missing required secret POLY_SUPER_ADMIN_USER_KEY in environment 'develop'"
exit 1
fi

curl --fail-with-body -X PATCH \
"${BASE_URL}/config-variables/SupportedClientVersions" \
-H "Authorization: Bearer ${POLY_SUPER_ADMIN_USER_KEY}" \
-H "Content-Type: application/json" \
-d "{\"name\":\"SupportedClientVersions\",\"value\":{\"python\":\"${VERSION}\"}}"

publish-na1:
name: Publish to PyPI and update na1 BE client-versions
runs-on: ubuntu-latest
needs: build-distribution
environment: na1
permissions:
id-token: write
steps:

- name: Download all the dists
uses: actions/download-artifact@v4
with:
name: python-package-distributions
path: dist/
- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
if: >-
${{
github.ref == 'refs/heads/main' ||
(
github.event_name == 'pull_request' &&
github.event.pull_request.merged == true &&
github.event.pull_request.head.ref == 'develop' &&
github.event.pull_request.base.ref == 'main'
)
}}


main-build:
name: Build distribution 📦
steps:
- name: Download all dists
uses: actions/download-artifact@v4
with:
name: python-package-distributions
path: dist/

- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1

- name: Update backend client-versions
env:
BASE_URL: https://na1.polyapi.io
VERSION: ${{ needs.build-distribution.outputs.package_version }}
POLY_SUPER_ADMIN_USER_KEY: ${{ secrets.POLY_SUPER_ADMIN_USER_KEY }}
shell: bash
run: |
if [[ -z "${POLY_SUPER_ADMIN_USER_KEY}" ]]; then
echo "Missing required secret POLY_SUPER_ADMIN_USER_KEY in environment 'na1'"
exit 1
fi

curl --fail-with-body -X PATCH \
"${BASE_URL}/config-variables/SupportedClientVersions" \
-H "Authorization: Bearer ${POLY_SUPER_ADMIN_USER_KEY}" \
-H "Content-Type: application/json" \
-d "{\"name\":\"SupportedClientVersions\",\"value\":{\"python\":\"${VERSION}\"}}"

publish-na2:
name: Publish to PyPI and update na2 client-versions
runs-on: ubuntu-latest
if: ${{ github.ref == 'refs/heads/main' }}
environment: main
needs: build-distribution
environment: na2
permissions:
id-token: write
if: >-
${{
github.event_name == 'pull_request' &&
github.event.pull_request.merged == true &&
github.event.pull_request.head.ref == 'main' &&
github.event.pull_request.base.ref == 'na2'
}}

steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.x"

- 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@v4
with:
name: python-package-distributions
path: dist/


main-publish-to-pypi:
name: >-
Publish Python 🐍 distribution 📦 to PyPI
if: ${{ github.ref == 'refs/heads/main' }}
needs:
- main-build
- name: Download all dists
uses: actions/download-artifact@v4
with:
name: python-package-distributions
path: dist/

- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1

- name: Update backend client-versions
env:
BASE_URL: https://na2.polyapi.io
VERSION: ${{ needs.build-distribution.outputs.package_version }}
POLY_SUPER_ADMIN_USER_KEY: ${{ secrets.POLY_SUPER_ADMIN_USER_KEY }}
shell: bash
run: |
if [[ -z "${POLY_SUPER_ADMIN_USER_KEY}" ]]; then
echo "Missing required secret POLY_SUPER_ADMIN_USER_KEY in environment 'na2'"
exit 1
fi

curl --fail-with-body -X PATCH \
"${BASE_URL}/config-variables/SupportedClientVersions" \
-H "Authorization: Bearer ${POLY_SUPER_ADMIN_USER_KEY}" \
-H "Content-Type: application/json" \
-d "{\"name\":\"SupportedClientVersions\",\"value\":{\"python\":\"${VERSION}\"}}"

publish-eu1:
name: Publish to PyPI and update eu1 BE client-versions
runs-on: ubuntu-latest
environment:
name: main
url: https://pypi.org/p/polyapi-python
needs: build-distribution
environment: eu1
permissions:
id-token: write

if: >-
${{
github.event_name == 'pull_request' &&
github.event.pull_request.merged == true &&
github.event.pull_request.head.ref == 'main' &&
github.event.pull_request.base.ref == 'eu1'
}}

steps:
- name: Download all the dists
uses: actions/download-artifact@v4
with:
name: python-package-distributions
path: dist/
- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
- name: Download all dists
uses: actions/download-artifact@v4
with:
name: python-package-distributions
path: dist/

- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1

- name: Update backend client-versions
env:
BASE_URL: https://eu1.polyapi.io
VERSION: ${{ needs.build-distribution.outputs.package_version }}
POLY_SUPER_ADMIN_USER_KEY: ${{ secrets.POLY_SUPER_ADMIN_USER_KEY }}
shell: bash
run: |
if [[ -z "${POLY_SUPER_ADMIN_USER_KEY}" ]]; then
echo "Missing required secret POLY_SUPER_ADMIN_USER_KEY in environment 'eu1'"
exit 1
fi

curl --fail-with-body -X PATCH \
"${BASE_URL}/config-variables/SupportedClientVersions" \
-H "Authorization: Bearer ${POLY_SUPER_ADMIN_USER_KEY}" \
-H "Content-Type: application/json" \
-d "{\"name\":\"SupportedClientVersions\",\"value\":{\"python\":\"${VERSION}\"}}"
3 changes: 3 additions & 0 deletions polyapi/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
from .rendered_spec import get_and_update_rendered_spec
from .prepare import prepare_deployables
from .sync import sync_deployables
from .version_check import check_for_client_version_update


def _get_version_string():
Expand All @@ -23,6 +24,8 @@ def _get_version_string():


def execute_from_cli():
check_for_client_version_update()

# First we setup all our argument parsing logic
# Then we parse the arguments (waaay at the bottom)
parser = argparse.ArgumentParser(
Expand Down
Loading
Loading