首頁 >後端開發 >Python教學 >可信任發布 - 發布 Python 套件從未如此簡單

可信任發布 - 發布 Python 套件從未如此簡單

Barbara Streisand原創: 2024-12-06 18:04:15509瀏覽

發布 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