Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Pull request overview
Adds an automated pipeline to keep the SDK’s PyPI long description aligned with the shipped release: the PyPI README is generated from README.md plus the current version’s changelog section, with repository links pinned to the release tag, and enforced in CI/publish.
Changes:
- Add
scripts/generate_pypi_readme.pyto generate/checksdk/PYPI_README.mdwith version-pinned links and embedded release notes. - Switch package metadata to publish
sdk/PYPI_README.mdas the PyPIreadme, and add CI + publish workflow steps to enforce/regenerate it. - Add a test to validate generation and sync of the committed PyPI README.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
scripts/generate_pypi_readme.py |
Implements generator/checker for the PyPI README with version-pinned link rewriting and changelog extraction. |
sdk/PYPI_README.md |
Adds the generated PyPI README artifact committed to the repo. |
sdk/pyproject.toml |
Points project.readme to PYPI_README.md for PyPI metadata. |
sdk/tests/test_pypi_readme_sync.py |
Adds tests to validate generated content and sync with committed README. |
.github/workflows/ci.yml |
Enforces README sync in CI and extends ruff lint to the generator script. |
.github/workflows/publish.yml |
Regenerates the PyPI README before building/publishing on tag pushes. |
ops/04-DEFINITION_OF_DONE.md |
Adds release checklist item to ensure PyPI README regeneration/sync. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Proof
558 passed, coverage93.96%python -m build ./sdkpassedpython -m twine check sdk/dist/*passed.codex-proof/pypi-readme-metadata.txtoutput/playwright/pypi-sync-home.pngoutput/playwright/pypi-sync-signin.pngNotes
sdk/PYPI_README.mdis generated; source-of-truth isREADME.md+CHANGELOG.md