|
| 1 | +name: Publish to PyPI |
| 2 | + |
| 3 | +# 仅在推送版本标签时触发，例如 v0.1.0 |
| 4 | +on: |
| 5 | + push: |
| 6 | + tags: |
| 7 | + - "v*" |
| 8 | + |
| 9 | +jobs: |
| 10 | + publish: |
| 11 | + # 在 GitHub 托管的 Ubuntu 运行环境中执行 |
| 12 | + runs-on: ubuntu-latest |
| 13 | + permissions: |
| 14 | + # 需要写仓库内容权限，用于创建/更新 GitHub Release |
| 15 | + contents: write |
| 16 | + # 需要 OIDC 令牌权限，供发布动作进行认证流程 |
| 17 | + id-token: write |
| 18 | + |
| 19 | + steps: |
| 20 | + # 1) 检出仓库代码到运行环境 |
| 21 | + - name: Checkout |
| 22 | + uses: actions/checkout@v4 |
| 23 | + |
| 24 | + # 2) 准备构建/发布使用的 Python 环境 |
| 25 | + - name: Setup Python |
| 26 | + uses: actions/setup-python@v5 |
| 27 | + with: |
| 28 | + python-version: "3.13" |
| 29 | + |
| 30 | + # 3) 安全校验：tag 版本必须与 pyproject.toml 中版本一致 |
| 31 | + - name: Verify tag matches pyproject version |
| 32 | + run: | |
| 33 | + python - <<'PY' |
| 34 | + import os |
| 35 | + import tomllib |
| 36 | + from pathlib import Path |
| 37 | +
|
| 38 | + tag = os.environ["GITHUB_REF_NAME"] |
| 39 | + if not tag.startswith("v"): |
| 40 | + raise SystemExit(f"Tag must start with v, got: {tag}") |
| 41 | +
|
| 42 | + tag_version = tag[1:] |
| 43 | + pyproject = Path("pyproject.toml") |
| 44 | + data = tomllib.loads(pyproject.read_text(encoding="utf-8")) |
| 45 | + project_version = data["project"]["version"] |
| 46 | +
|
| 47 | + if tag_version != project_version: |
| 48 | + raise SystemExit( |
| 49 | + f"Tag version ({tag_version}) != pyproject version ({project_version})" |
| 50 | + ) |
| 51 | +
|
| 52 | + print(f"Version check passed: {project_version}") |
| 53 | + PY |
| 54 | +
|
| 55 | + # 4) 构建 wheel/sdist，并校验包元数据 |
| 56 | + - name: Build package |
| 57 | + run: | |
| 58 | + python -m pip install --upgrade pip |
| 59 | + python -m pip install build twine |
| 60 | + python -m build |
| 61 | + python -m twine check dist/* |
| 62 | +
|
| 63 | + # 5) 上传构建产物到 PyPI |
| 64 | + - name: Publish package to PyPI |
| 65 | + uses: pypa/gh-action-pypi-publish@release/v1 |
| 66 | + with: |
| 67 | + password: ${{ secrets.PYPI_API_TOKEN }} |
| 68 | + |
| 69 | + # 6) 基于当前 tag 创建 GitHub Release，并附加 dist 文件 |
| 70 | + - name: Create GitHub Release |
| 71 | + uses: softprops/action-gh-release@v2 |
| 72 | + with: |
| 73 | + tag_name: ${{ github.ref_name }} |
| 74 | + name: Release ${{ github.ref_name }} |
| 75 | + generate_release_notes: true |
| 76 | + files: | |
| 77 | + dist/* |
0 commit comments