Set up PyPI publishing via GitHub Actions#54
Conversation
There was a problem hiding this comment.
Pull request overview
Sets up automated, release-driven publishing to PyPI (using GitHub Actions + OIDC trusted publishing) and refreshes project packaging metadata/documentation so the first PyPI release renders correctly and has updated guidance.
Changes:
- Add a release-triggered GitHub Actions workflow that runs CI and then publishes to PyPI from a protected
pypienvironment. - Update
pyproject.tomlwithreadme = "README.md"and bump version to0.4.3. - Restructure/expand the README with a TOC and updated “getting started” + integrations narrative.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
pyproject.toml |
Bumps version and configures PyPI to render README.md. |
README.md |
Major documentation rewrite/restructure (TOC, onboarding flow, integrations framing). |
.github/workflows/publish.yml |
Adds the release-triggered CI + PyPI publish workflow using OIDC. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
c77ba1a to
b973750
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add a release-triggered workflow that runs CI, builds the package with Poetry, and publishes to PyPI via OIDC trusted publishing. Point pyproject.toml at README.md so the rendered project page has context, and reorganize the README itself around a clearer narrative arc with a table of contents. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
b973750 to
5fe8b35
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Enables release-triggered publishing to PyPI. When a GitHub release is published (with a tag matching
v*), a workflow runs CI and then publishes the built package to PyPI via OIDC trusted publishing — no API tokens required.Also overhauls the README around a clearer narrative arc (problem -> concepts -> getting started -> core API -> integrations) with a table of contents, and reframes the
examples/directory as reference material rather than shipped code.Changes
.github/workflows/publish.yml— CI job (lint + test) followed by apublishjob gated on thepypienvironment, usingpypa/gh-action-pypi-publishwith OIDCrelease: types: [published]so releases created from the GitHub UI drive the flowreadme = "README.md"topyproject.tomlso PyPI renders project context on first publish0.4.3in preparation for the first PyPI releasevrepackage)VRE Design Alignment
Infrastructure / documentation only. No changes to grounding, policy evaluation, gap detection, primitives, relation types, or depth semantics. Epistemic honesty invariants are unaffected.
Test Plan
v0.4.3release from the GitHub UIcijob passespublishjob runs in thepypienvironment and succeedsNotes
publish.yml, environmentpypi) before the first release — done out-of-band.pypienvironment is configured with a deployment tag rule (v*), so arbitrary branches cannot trigger a publish.