Skip to content

Update README to remove PyPI configuration steps #3

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
Minibrams merged 1 commit into from
Apr 28, 2026
Merged

Update README to remove PyPI configuration steps #3

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
10 changes: 0 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,6 @@ book = client.get("/books/{book_id}")(params={"book_id": 1})

Releases are published from the protected `releases` branch. The package version is set manually in `pyproject.toml`, and pushing a release commit to `releases` triggers the GitHub Actions release workflow. The workflow creates the matching `vX.Y.Z` tag after checks pass.

Before the first release, configure PyPI Trusted Publishing for this repository:

- PyPI project: `openapi-python`
- GitHub workflow: `release.yml`
- GitHub environment: `pypi`

The GitHub `pypi` environment should be limited to deployments from the `releases` branch.

Release steps:

```bash
Expand All @@ -190,5 +182,3 @@ uv run python scripts/release.py --version 0.1.0
# 2. If checks pass, push the current commit to the releases branch.
uv run python scripts/release.py --version 0.1.0 --push-release-branch
```

The release workflow verifies that the version tag does not already exist, runs checks, builds the distributions, validates them with `twine`, creates the release tag, publishes to PyPI, and creates a GitHub Release with generated notes.
Loading