ci: infra to submit to PyPI

.github/workflows/ci.yaml

@@ -51,11 +51,32 @@ jobs:
         run: 'just quality'
         env:
           UV_PYTHON_VERSION: '3.12'
+  build-check:
+    name: 'build-check'
+    runs-on: 'ubuntu-latest'
+    steps:
+      - name: 'checkout repository'
+        uses: 'actions/checkout@v6'
+        with:
+          persist-credentials: false
+      - name: 'install just'
+        uses: 'extractions/setup-just@v3'
+      - name: 'setup uv'
+        uses: 'astral-sh/setup-uv@v7'
+        with:
+          enable-cache: true
+          cache-dependency-glob: '**/pyproject.toml'
+          python-version: '3.12'
+      - name: 'run build validation'
+        run: 'just build-check'
+        env:
+          UV_PYTHON_VERSION: '3.12'
   tests:
     name: 'tests (${{ matrix.python-version }})'
     needs:
       - 'quality'
       - 'docs'
+      - 'build-check'
     runs-on: 'ubuntu-latest'
     strategy:
       matrix:

.github/workflows/gh-pages.yaml

@@ -5,10 +5,27 @@ name: 'GitHub Pages Documentation'
   push:
     branches:
       - 'main'
-  release:
-    types:
-      - 'published'
+  workflow_call:
+    inputs:
+      deploy-mode:
+        description: 'Deployment mode used to determine docs aliases'
+        required: false
+        default: 'push'
+        type: 'string'
   workflow_dispatch:
+    inputs:
+      deploy-mode:
+        description: 'Deployment mode used to determine docs aliases'
+        required: false
+        default: 'push'
+        type: 'choice'
+        options:
+          - 'push'
+          - 'release'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 permissions:
   contents: 'read'
@@ -44,7 +61,7 @@ jobs:
           enable-cache: true
           cache-dependency-glob: 'pyproject.toml'
           python-version: '${{ matrix.python-version }}'
-      - name: 'Extract flepimop2 version'
+      - name: 'Extract op_system version'
         id: extract-version
         run: |
           cat > version.py << EOF
@@ -59,10 +76,25 @@ jobs:
           rm version.py
       - name: 'Build API Reference'
         run: 'just api-reference'
+      - name: 'Determine deploy mode'
+        id: determine-mode
+        run: |
+          if [ "${EVENT_NAME}" = "workflow_call" ]; then
+            echo "deploy-mode=${CALL_MODE}" >> "${GITHUB_OUTPUT}"
+          elif [ "${EVENT_NAME}" = "workflow_dispatch" ] \
+            && [ -n "${DISPATCH_MODE}" ]; then
+            echo "deploy-mode=${DISPATCH_MODE}" >> "${GITHUB_OUTPUT}"
+          else
+            echo "deploy-mode=push" >> "${GITHUB_OUTPUT}"
+          fi
+        env:
+          CALL_MODE: '${{ inputs.deploy-mode }}'
+          DISPATCH_MODE: '${{ github.event.inputs.deploy-mode }}'
+          EVENT_NAME: '${{ github.event_name }}'
       - name: 'Deploy to GitHub Pages'
         run: |
           uv run mike set-default latest
-          if [ "${EVENT_NAME}" == "release" ] || [[ $VERSION == 0* ]]; then
+          if [ "${DEPLOY_MODE}" = "release" ] || [[ $VERSION == 0* ]]; then
             ALIAS=latest
           else
             ALIAS=dev
@@ -71,6 +103,6 @@ jobs:
             --push --update-aliases \
             ${VERSION} ${ALIAS}
         env:
-          EVENT_NAME: "${{ github.event_name }}"
+          DEPLOY_MODE: "${{ steps.determine-mode.outputs.deploy-mode }}"
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           VERSION: "${{ steps.extract-version.outputs.version }}"

.github/workflows/release.yaml

@@ -0,0 +1,196 @@
+---
+name: 'Release'
+
+'on':
+  workflow_dispatch:
+    inputs:
+      publish-target:
+        description: 'Package publish target'
+        required: true
+        default: 'none'
+        type: 'choice'
+        options:
+          - 'none'
+          - 'testpypi'
+          - 'pypi'
+      create-github-release:
+        description: 'Create the GitHub release after publishing'
+        required: true
+        default: false
+        type: 'boolean'
+      deploy-docs:
+        description: 'Deploy versioned docs after creating the GitHub release'
+        required: true
+        default: false
+        type: 'boolean'
+
+permissions:
+  contents: 'read'
+
+jobs:
+  validate:
+    name: 'Validate release'
+    runs-on: 'ubuntu-latest'
+    outputs:
+      version: '${{ steps.validate-version.outputs.version }}'
+      docs-version: '${{ steps.validate-version.outputs.docs-version }}'
+      prerelease: '${{ steps.validate-version.outputs.prerelease }}'
+    steps:
+      - name: 'Install just'
+        run: 'sudo apt install just'
+      - name: 'Checkout repository'
+        uses: 'actions/checkout@v6'
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: 'Setup uv with python 3.12'
+        uses: 'astral-sh/setup-uv@v7.2.0'
+        with:
+          enable-cache: true
+          cache-dependency-glob: |
+            pyproject.toml
+            flepimop2-op_system/pyproject.toml
+          python-version: '3.12'
+      - name: 'Validate shared package version'
+        id: validate-version
+        run: 'uv run python scripts/release_validate.py --github-output "${GITHUB_OUTPUT}"'
+      - name: 'Run release build validation'
+        run: 'just build-all'
+        env:
+          UV_PYTHON_VERSION: '3.12'
+      - name: 'Build core release artifacts'
+        run: |
+          rm -rf release-dist
+          mkdir -p release-dist/op_system
+          uv run --with build --with twine python -m build --outdir release-dist/op_system
+          uv run --with twine python -m twine check --strict release-dist/op_system/*
+      - name: 'Build provider release artifacts'
+        run: |
+          mkdir -p release-dist/flepimop2-op_system
+          cd flepimop2-op_system
+          uv run --with build --with twine python -m build --outdir ../release-dist/flepimop2-op_system
+          uv run --with twine python -m twine check --strict ../release-dist/flepimop2-op_system/*
+      - name: 'Upload core package artifacts'
+        uses: 'actions/upload-artifact@v4'
+        with:
+          name: 'op-system-dist'
+          path: 'release-dist/op_system/*'
+          if-no-files-found: 'error'
+      - name: 'Upload provider package artifacts'
+        uses: 'actions/upload-artifact@v4'
+        with:
+          name: 'flepimop2-op-system-dist'
+          path: 'release-dist/flepimop2-op_system/*'
+          if-no-files-found: 'error'
+
+  publish-core:
+    name: 'Publish op_system'
+    needs:
+      - 'validate'
+    runs-on: 'ubuntu-latest'
+    env:
+      PACKAGE_DIST_DIR: 'dist/op_system'
+    permissions:
+      id-token: 'write'
+    steps:
+      - name: 'Skip core publish'
+        if: "${{ github.event.inputs.publish-target == 'none' }}"
+        run: 'echo "publish-target=none; skipping op_system publish."'
+      - name: 'Download core package artifacts'
+        if: "${{ github.event.inputs.publish-target != 'none' }}"
+        uses: 'actions/download-artifact@v4'
+        with:
+          name: 'op-system-dist'
+          path: '${{ env.PACKAGE_DIST_DIR }}'
+      - name: 'Publish core package to TestPyPI'
+        if: "${{ github.event.inputs.publish-target == 'testpypi' }}"
+        uses: 'pypa/gh-action-pypi-publish@release/v1'
+        with:
+          packages-dir: '${{ env.PACKAGE_DIST_DIR }}'
+          repository-url: 'https://test.pypi.org/legacy/'
+      - name: 'Publish core package to PyPI'
+        if: "${{ github.event.inputs.publish-target == 'pypi' }}"
+        uses: 'pypa/gh-action-pypi-publish@release/v1'
+        with:
+          packages-dir: '${{ env.PACKAGE_DIST_DIR }}'
+
+  publish-provider:
+    name: 'Publish flepimop2-op_system'
+    needs:
+      - 'validate'
+      - 'publish-core'
+    runs-on: 'ubuntu-latest'
+    env:
+      PACKAGE_DIST_DIR: 'dist/flepimop2-op_system'
+    permissions:
+      id-token: 'write'
+    steps:
+      - name: 'Skip provider publish'
+        if: "${{ github.event.inputs.publish-target == 'none' }}"
+        run: 'echo "publish-target=none; skipping flepimop2-op_system publish."'
+      - name: 'Download provider package artifacts'
+        if: "${{ github.event.inputs.publish-target != 'none' }}"
+        uses: 'actions/download-artifact@v4'
+        with:
+          name: 'flepimop2-op-system-dist'
+          path: '${{ env.PACKAGE_DIST_DIR }}'
+      - name: 'Publish provider package to TestPyPI'
+        if: "${{ github.event.inputs.publish-target == 'testpypi' }}"
+        uses: 'pypa/gh-action-pypi-publish@release/v1'
+        with:
+          packages-dir: '${{ env.PACKAGE_DIST_DIR }}'
+          repository-url: 'https://test.pypi.org/legacy/'
+      - name: 'Publish provider package to PyPI'
+        if: "${{ github.event.inputs.publish-target == 'pypi' }}"
+        uses: 'pypa/gh-action-pypi-publish@release/v1'
+        with:
+          packages-dir: '${{ env.PACKAGE_DIST_DIR }}'
+
+  create-github-release:
+    name: 'Create GitHub release'
+    needs:
+      - 'validate'
+      - 'publish-provider'
+    if: >-
+      ${{
+        github.event.inputs.create-github-release == 'true' &&
+        (github.event.inputs.publish-target == 'none' ||
+        needs.publish-provider.result == 'success')
+      }}
+    runs-on: 'ubuntu-latest'
+    permissions:
+      contents: 'write'
+    steps:
+      - name: 'Create release'
+        run: |
+          ARGS=(
+            release create "v${VERSION}"
+            --target "${GITHUB_SHA}"
+            --title "v${VERSION}"
+            --generate-notes
+          )
+          if [ "${PRERELEASE}" = 'true' ]; then
+            ARGS+=(--prerelease)
+          fi
+          gh "${ARGS[@]}"
+        env:
+          GH_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+          GITHUB_SHA: '${{ github.sha }}'
+          PRERELEASE: '${{ needs.validate.outputs.prerelease }}'
+          VERSION: '${{ needs.validate.outputs.version }}'
+
+  deploy-docs:
+    name: 'Deploy release docs'
+    needs:
+      - 'create-github-release'
+    if: >-
+      ${{
+        github.event.inputs.deploy-docs == 'true' &&
+        needs.create-github-release.result == 'success'
+      }}
+    permissions:
+      contents: 'write'
+    uses: './.github/workflows/gh-pages.yaml'
+    with:
+      deploy-mode: 'release'
+    secrets: 'inherit'