Skip to content

docs: document protected PyPI publishing - #789

Open
zhongkechen wants to merge 10 commits into
mainfrom
docs/first-pypi-publication
Open

zhongkechen wants to merge 10 commits into
mainfrom
docs/first-pypi-publication

Conversation

@zhongkechen

@zhongkechen zhongkechen commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Document how to publish a new or renamed Python distribution to PyPI for the first time: the exact trusted-publisher form values, initial version selection, when the name is claimed, and verification after upload.

Align the release process with the repository's protections. The pypi environment accepts only the four configured release-tag patterns, and tag creation is governed by the protected-tags ruleset. Explain why branch runs cannot publish, require the tag to point at the merged commit whose CI passed, treat published tags as immutable, and configure new prefixes in both sets of rules.

Clarify that a release publishes every PyPI matrix entry. After PyPI publishing succeeds, the emulator workflow publishes an image only when the release tag includes testing-v<version>. Publishing a single new package requires reviewed workflow changes compatible with the protected tag process; PyPI organization project creation remains an option for claiming only the name.

Validation: compared the instructions with the live pypi environment deployment policies, protected-tags ruleset, and current workflows. Checked GitHub Markdown rendering and local links/anchors. git diff --check and commit-message lint pass. Documentation only; SDK tests were not run.

@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 19, 2026 23:25 — with GitHub Actions Inactive
@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 19, 2026 23:26 — with GitHub Actions Inactive
@github-actions

This comment has been minimized.

@zhongkechen zhongkechen changed the title docs: document first PyPI publication docs: document protected PyPI publishing Oct 19, 2026
@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 19, 2026 23:46 — with GitHub Actions Inactive
@github-actions

This comment has been minimized.

@zhongkechen
zhongkechen requested a review from hln33 October 20, 2026 00:25
@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 20, 2026 19:44 — with GitHub Actions Inactive
@github-actions

This comment has been minimized.

@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 21, 2026 00:10 — with GitHub Actions Inactive
Comment thread RELEASING.md Outdated
@github-actions

This comment has been minimized.

@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 21, 2026 17:13 — with GitHub Actions Inactive
Comment thread RELEASING.md Outdated
@github-actions

This comment has been minimized.

@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 22, 2026 16:02 — with GitHub Actions Inactive
Comment thread RELEASING.md Outdated
@github-actions

This comment has been minimized.

@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 23, 2026 21:01 — with GitHub Actions Inactive
Comment thread RELEASING.md Outdated
@github-actions

This comment has been minimized.

@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime October 23, 2026 23:50 — with GitHub Actions Inactive
Comment thread RELEASING.md Outdated
@github-actions

This comment has been minimized.

@zhongkechen
zhongkechen deployed to ai-pr-review-runtime October 26, 2026 17:40 — with GitHub Actions Active
Comment thread RELEASING.md Outdated
Comment on lines +120 to +122
also triggers [`ecr-release.yml`](.github/workflows/ecr-release.yml), which
publishes the testing emulator image. Do not create a GitHub release solely to
claim one name if those other publications are not intended.

This comment was marked as outdated.

@github-actions

This comment has been minimized.

@zhongkechen
zhongkechen deployed to ai-pr-review-runtime October 27, 2026 22:27 — with GitHub Actions Active
@github-actions

Copy link
Copy Markdown
Contributor

Codex AI review

No actionable findings after reviewing the complete diff against CONTRIBUTING rules 1–9. The prior emulator-publication finding is resolved. Documentation-only change; tests were not run, and live GitHub/PyPI settings were not independently verified.

Reviewed commit 0f0b0607147684a94d296c7b2ffdb95854efade7. Workflow run

This branch was successfully deployed

1 active deployment
ai-pr-review-runtime — 0f0b0607 Deployed Oct 27, 2026 by zhongkechen via ai-pr-review / Codex review / Generate Codex review #2530
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant