信頼できる公開 - Python パッケージの公開がかつてないほど簡単になりました-Python チュートリアル-php.cn

ホームページ

バックエンド開発

Python チュートリアル

信頼できる公開 - Python パッケージの公開がかつてないほど簡単になりました

Barbara Streisand

Dec 06, 2024 pm 06:04 PM

Python パッケージの公開はかつては困難な作業でしたが、今はそうではありません。さらに良いことに、安全性が大幅に向上しました。 CLI ツールに依存しながら、ユーザー名、パスワード、または API トークンをやりくりする時代は終わりました。信頼できる公開では、GitHub リポジトリの詳細を PyPI に提供するだけで、GitHub Actions が面倒な作業を処理します。

信頼できる公開で Python パッケージを公開する方法

(開発ブランチで) タグが作成されたときにパッケージを TestPyPi に公開するか、メインブランチにマージするときに PyPi にパッケージを公開するワークフローを紹介します。

パッケージの公開を準備する

Python パッケージが PyPI のパッケージ化ガイドラインに従っていることを確認してください。少なくとも次のものが必要です:

パッケージのメタデータを定義する ~~setup.py または~~ pyproject.toml ファイル。
明確なディレクトリレイアウトを備えた適切に構造化されたコード。
PyPI でプロジェクトを紹介するための README ファイル。

詳細なチェックリストについては、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

GitHub環境を構成する

特定のタグのみが公開ワークフローをトリガーし、リリースプロセスの制御を維持するため。
[設定] -> [設定] に移動して、新しい環境のテストリリースを作成します。 GitHub リポジトリ内の環境。

環境を設定し、デプロイメントタグルールを追加します。