第12章 为现有 PyPI 项目添加 Trusted Publisher
为现有 PyPI 项目添加 Trusted Publisher
给 PyPI 项目添加 Trusted Publisher 只需一步配置。
在 "Your projects" 页面,点击要配置的项目旁边的 "Manage":
然后在项目侧边栏点击 "Publishing":
这个链接会跳转到该项目的发布配置页面,你可以在这里为 PyPI 支持的不同平台(比如 GitHub Actions)配置 Trusted Publisher。
要启用某个 publisher,需要告诉 PyPI 如何信任它。每种 trusted publisher 有各自的配置要求,点击下面的标签查看。
GitHub ActionsGoogle CloudActiveStateGitLab CI/CD
对于 GitHub Actions,你需要提供仓库所有者名称、仓库名称,以及被授权上传到 PyPI 的 GitHub Actions workflow 文件名。此外,还可以选择性地提供 GitHub Actions environment 的名称。
比如你的项目在 https://github.com/octo-org/sampleproject,发布 workflow 定义在 .github/workflows/release.yml,还有一个名为 pypi 的自定义 environment,那么配置如下:
注意 配置 environment 是可选的,但强烈推荐:借助 GitHub environment,你可以给 trusted workflow 加上额外限制,比如要求仓库维护者中受信任的成员在每次运行时手动审批。
点击 "Add" 后,publisher 就注册成功,并会显示在页面顶部:
从这时起,octo-org/sampleproject 上的 release.yml workflow 就能从 PyPI 获取针对该项目的短期 API token 了。
对于 Google Cloud,你需要提供用于发布的账户或 service account 的邮箱地址。关于 Google Cloud service account 的更多信息可以在这里了解。
比如你在 "PROJECT_NAME" 项目中创建了名为 "SERVICE_ACCOUNT_NAME" 的 service account,用于从该环境发布到 PyPI,那么它的邮箱格式为 SERVICE_ACCOUNT_NAME@PROJECT_NAME.iam.gserviceaccount.com,配置如下:
警告 Google Cloud 还为多种产品提供了默认 service account:
Compute Engine: PROJECT_ID-compute@developer.gserviceaccount.com App Engine: PROJECT_NAME@appspot.gserviceaccount.com
但不建议用它们来发布,因为它们是每个服务创建时默认自带的。
注意 配置 subject 是可选的。subject 是代表请求发起方的数字 ID。虽然不是必需项,但提供 subject 可以进一步收紧发布身份,确保只有 service account 的特定实例能发布,而不是任何使用该邮箱的 service account。详情见 https://cloud.google.com/docs/authentication/token-types#id-contents
点击 "Add" 后,publisher 就注册成功,并会显示在页面顶部:
对于 ActiveState,你需要提供 ActiveState 项目名称、该项目所属的 ActiveState 组织,以及执行发布操作的 ActiveState 用户。关于 ActiveState Platform 的入门设置可以在这里了解更多。
点击 "Add" 后,publisher 就注册成功,并会显示在页面顶部:
注意 目前仅支持托管在 https://gitlab.com 上的项目,不支持自建实例。
对于 GitLab CI/CD,你需要提供仓库的 namespace、仓库名称,以及被授权上传到 PyPI 的顶层 GitLab CI/CD pipeline 定义文件路径。此外,还可以选择性地提供 GitLab CI/CD environment 的名称。
比如你的项目在 https://gitlab.com/namespace/sampleproject,顶层 pipeline 定义在 .gitlab-ci.yml,还有一个名为 release 的自定义 environment,那么配置如下:
注意 配置 environment 是可选的,但强烈推荐:借助 GitLab environment,你可以给 trusted workflow 加上额外限制,比如要求仓库维护者中受信任的成员在每次运行时手动审批。
点击 "Add" 后,publisher 就注册成功,并会显示在页面顶部:
从这时起,namespace/sampleproject 上的 .gilab-ci.yml pipeline 就能从 PyPI 获取针对该项目的短期 API token 了。
同一个 publisher 可以关联多个 PyPI 项目(比如 monorepo 场景),同一个 PyPI 项目也可以配置多个 publisher(比如针对不同架构、不同操作系统的多个 workflow)。