Skip to content

Document TestPyPI as optional #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cbusillo merged 1 commit into from
Apr 26, 2026
Merged

Document TestPyPI as optional #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This repository is maintained as a careful, community-oriented Python client for

- Do not publish releases from unreviewed local state.
- Build and validate distributions before release.
- Use TestPyPI before first publishing under a new distribution name.
- Prefer TestPyPI before first publishing under a new distribution name, but allow skipping it when CI, build metadata checks, and release-tag guards are sufficient.
- Run the manual `Publish` workflow from a `v*` release tag only.
- Keep the `testpypi` environment unblocked by manual review.
- Keep the `pypi` environment protected by maintainer approval.
Expand Down
11 changes: 6 additions & 5 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,14 @@ git push origin vX.Y.Z
```

10. Create a GitHub Release from the tag using the changelog section as release notes.
11. Run the manual `Publish` workflow from the release tag for TestPyPI first.
12. Install from TestPyPI in a clean environment and smoke-test imports.
13. Run the manual `Publish` workflow from the release tag for PyPI only after TestPyPI passes.
11. Optionally run the manual `Publish` workflow from the release tag for TestPyPI.
12. If TestPyPI is used, install from TestPyPI in a clean environment and smoke-test imports.
13. Run the manual `Publish` workflow from the release tag for PyPI.

## TestPyPI Smoke Test
## Optional TestPyPI Smoke Test

Use a clean environment:
TestPyPI is a useful publishing dry run, but it is not required for every
release. Use a clean environment when testing a TestPyPI upload:

```sh
uv venv /tmp/printnode_community-release-smoke
Expand Down