可信发布 - 发布 Python 包从未如此简单-Python教程-PHP中文网

首页

后端开发

Python教程

可信发布 - 发布 Python 包从未如此简单

Barbara Streisand

Dec 06, 2024 pm 06:04 PM

发布 Python 包曾经是一项艰巨的任务，但现在不再是了。更好的是，它变得更加安全。依靠 CLI 工具同时处理用户名、密码或 API 令牌的日子已经一去不复返了。通过可信发布，您只需向 PyPI 提供 GitHub 存储库的详细信息，GitHub Actions 就会负责繁重的工作。

如何通过可信发布来发布 Python 包

我将介绍一个工作流程，当创建标签时（在开发分支上）将您的包发布到 TestPyPi，或者当您合并到主分支时将包发布到 PyPi。

准备发布包

确保您的 Python 包遵循 PyPI 的打包指南。您至少需要：

定义包元数据的 ~~setup.py 或~~ pyproject.toml 文件。
结构正确的代码，具有清晰的目录布局。
用于在 PyPI 上展示您的项目的自述文件。

有关详细清单，请参阅《Python 打包用户指南》。

在您的存储库中配置 GitHub 操作

让我们首先创建一个新的 GitHub 操作 .github/workflows/test-build-publish.yml。

name: test-build-publish

on: [push, pull_request]

permissions:
  contents: read

jobs:

  build-and-check-package:
    name: Build & inspect our package.
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: hynek/build-and-inspect-python-package@v2

此操作将构建您的包，并将构建的轮子和源代码分发 (SDist) 作为 GitHub Actions 工件上传。

接下来，我们添加一个发布到 TestPyPI 的步骤。每当创建标签时都会运行此步骤，以确保上一步的构建已成功完成。将 PROJECT_OWNER 和 PROJECT_NAME 替换为适合您的存储库的值。

  test-publish:
    if: >-
        github.event_name == 'push' &&
        github.repository == 'PROJECT_OWNER/PROJECT_NAME' &&
        startsWith(github.ref, 'refs/tags')
    needs: build-and-check-package
    name: Test publish on TestPyPI
    runs-on: ubuntu-latest
    environment: test-release
    permissions:
      id-token: write
    steps:
      - name: Download packages built by build-and-check-package
        uses: actions/download-artifact@v4
        with:
          name: Packages
          path: dist

      - name: Upload package to Test PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          repository-url: https://test.pypi.org/legacy/

此步骤下载在构建过程中创建的工件并将其上传到 TestPyPI 进行测试。

最后一步，当拉取请求合并到主分支时，我们会将包上传到 PyPI。

  publish:
    if: >-
      github.event_name == 'push' &&
      github.repository == 'PROJECT_OWNER/PROJECT_NAME' &&
      github.ref == 'refs/heads/main'
    needs: build-and-check-package
    name: Publish to PyPI
    runs-on: ubuntu-latest
    environment: release
    permissions:
      id-token: write
    steps:
      - name: Download packages built by build-and-check-package
        uses: actions/download-artifact@v4
        with:
          name: Packages
          path: dist

      - name: Publish distribution ? to PyPI for push to main
        uses: pypa/gh-action-pypi-publish@release/v1