poetry-publish 镜像文档

镜像概述

poetry-publish 是一个用于 GitHub Actions 的 Docker 镜像，通过 Poetry（[] Python 包到 PyPI（[] Python 包的自动化构建与发布流程，支持自定义 Python 和 Poetry 版本，并可适配官方 PyPI、测试 PyPI 或私有仓库。

核心功能与特性

• 自动安装指定版本的 Python 和 Poetry
• 支持通过 PyPI API 令牌进行身份验证
• 默认发布到官方 PyPI，可配置发布到测试 PyPI 或私有仓库
• 与 GitHub Actions 无缝集成，支持通过工作流触发发布流程

输入参数

python_version

要安装的 Python 版本（默认值：latest）。使用默认值可缩短构建时间。

poetry_version

要安装的 Poetry 版本（默认值：latest）。

pypi_token

必填 上传包到 PyPI 时用于身份验证的 API 令牌（获取地址：[***]

repository_name

包将上传到的仓库名称。如需上传到测试 PyPI 或私有 wheel 仓库时必填。未指定时默认上传到官方 PyPI。

repository_url

包将上传到的仓库 URL。如需上传到测试 PyPI 或私有 wheel 仓库时必填。未指定时默认上传到官方 PyPI。

示例用法

基础用法

以下示例使用最新版本的 Python 和 Poetry 构建并发布 Python 包。项目根目录下的 pyproject.toml 文件需指定 Python 包版本及依赖。

- name: 构建并发布到 PyPI
  uses: JRubics/poetry-publish@v1
  with:
    pypi_token: ${{ secrets.PYPI_TOKEN }}

指定版本和仓库

可在输入参数中指定 Python 和 Poetry 版本，以及目标仓库信息：

- name: 构建并发布到 PyPI
  uses: JRubics/poetry-publish@v1
  with:
    python_version: '3.7.1'  # 指定 Python 版本
    poetry_version: '==1.0.5'  # 使用 PIP 版本规范语法
    pypi_token: ${{ secrets.PYPI_TOKEN }}
    repository_name: 'testpypi'  # 测试 PyPI 仓库名称
    repository_url: '[***]  # 测试 PyPI 仓库 URL

示例工作流

以下工作流将在项目推送 v*.*.* 格式的标签时触发，自动构建并发布 Python 包：

name: Python 包发布
on:
  push:
    tags:
      - 'v*.*.*'  # 匹配 v1.0.0、v2.3.4 等标签格式
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2  # 检出代码
    - name: 构建并发布到 PyPI
      uses: JRubics/poetry-publish@v1
      with:
        pypi_token: ${{ secrets.PYPI_TOKEN }}  # 从 GitHub Secrets 获取 PyPI 令牌