openptv-python/.github/workflows/publish-to-pypi.yml at d8af22b75a57db340bbdfa253636621bc985bc28 · OpenPTV/openptv-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
name: Publish Python Package to PyPI

# This workflow uses GitHub's OIDC trusted publishing to authenticate with PyPI.
# For this to work, you must configure trusted publishers on PyPI/TestPyPI:
# 1. Go to https://test.pypi.org/ or https://pypi.org/
# 2. Navigate to your project settings → Publishing
# 3. Add a new publisher with these details:
#    - Owner: alexlib
#    - Repository: openptv-python
#    - Workflow: publish-to-pypi.yml
#    - Environment: testpypi (for TestPyPI) or pypi (for PyPI)
#
# TROUBLESHOOTING:
# If you see "invalid-publisher" error, it means the trusted publisher is not configured
# correctly on PyPI/TestPyPI. The configuration MUST match these exact values:
# - Repository owner: alexlib
# - Repository name: openptv-python
# - Workflow filename: publish-to-pypi.yml (must be exact match)
# - Environment name: testpypi or pypi (must match exactly)
#
# For detailed setup instructions, see DEPLOYMENT.md

on:
  release:
    types: [published]
  workflow_dispatch:
    inputs:
      deploy_target:
        description: 'Deploy to PyPI or TestPyPI'
        required: true
        default: 'testpypi'
        type: choice
        options:
          - pypi
          - testpypi

jobs:
  build:
    name: Build distribution
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

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

      - name: Install build dependencies
        run: |
          python -m pip install --upgrade pip
          pip install build twine

      - name: Build package
        run: python -m build

      - name: Check distribution
        run: twine check dist/*

      - name: Upload artifacts
        uses: actions/upload-artifact@v4
        with:
          name: python-package-distributions
          path: dist/

  publish-to-pypi:
    name: Publish to PyPI
    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_target == 'pypi')
    needs: [build]
    runs-on: ubuntu-latest
    environment:
      name: pypi  # This must match the environment name in PyPI's trusted publisher config
      url: https://pypi.org/p/openptv-python
    permissions:
      id-token: write  # Required for trusted publishing via OIDC

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

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

  publish-to-testpypi:
    name: Publish to TestPyPI
    if: github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_target == 'testpypi'
    needs: [build]
    runs-on: ubuntu-latest
    environment:
      name: testpypi  # This must match the environment name in TestPyPI's trusted publisher config
      url: https://test.pypi.org/p/openptv-python
    permissions:
      id-token: write  # Required for trusted publishing via OIDC

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

      - name: Publish to TestPyPI
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          repository-url: https://test.pypi.org/legacy/