Fix README for pypi
Metadata
Current evaluation
Fixed PyPI packaging by selecting the correct README; PR #53 merged as commit adcc07a, resolving the malformed or missing long-description warnings.
Resolution: closed resolved
Reason: PR canonical/craft-grammar#53 corrected the README used for PyPI packaging and explicitly fixed #52. The merged change landed as commit adcc07a.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Currently the auto-publish workflow is failing due to warnings about the README: https://github.com/canonical/craft-grammar/actions/runs/10930161804/job/30342485131
Specifically:
```
Successfully built craft_grammar-2.0.1.tar.gz and craft_grammar-2.0.1-py3-none-any.whl
Checking dist/craft_grammar-2.0.1-py3-none-any.whl: FAILED
ERROR `long_description` has syntax errors in markup and would not be
rendered on PyPI.
No content rendered from RST source.
Checking dist/craft_grammar-2.0.1.tar.gz: PASSED with warnings
WARNING `long_description` missing.
```
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Fixed PyPI packaging by selecting the correct README; PR #53 merged as commit adcc07a, resolving the malformed or missing long-description warnings. | |
| stealth/space-bunny-alpha | — | closed resolved | Fixed by merged PR #53 (commit adcc07a), which selected the correct Markdown README for PyPI packaging and resolved the publish validation failure. | |
| stealth/space-bunny-alpha | — | closed resolved | Fixed by merged PR #53, which corrected the README used for PyPI packaging (commit adcc07a). | |
| qwen/qwen3.6-35b-a3b | — | — | Abandoned. The README markup errors blocking PyPI publishing were deferred to an internal Jira ticket (CRAFT-3394) for tracking. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed and synced to Jira (CRAFT-3394) without a GitHub fix or merge. The README markup errors causing PyPI publish failures were tracked externally, with no resolution provided on this repository. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed to resolve failing PyPI publish workflow caused by README markup errors. The long_description formatting was corrected to ensure proper rendering and successful package publishing. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/craft-grammar#53
(confidence 99%)
Merged PR that corrected the PyPI README configuration and closed the issue.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #53 fix(docs): get the correct readme for pypi | craft-grammar | merged | Merged #53 corrected the README used for PyPI packaging, resolving #52; landed as commit adcc07a. | |
| #214 Fix syntax errors in readme | craft-store | closed | Fixed by PR #258 (commit 7d2790e), which updated the README and packaging template to correct the build error blocking automated PyPI releases. | |
| #93 Fix description rendering on PyPI | craft-providers | merged | Merged PR #93 via commit 26116ff, adding the text/markdown content type to package metadata so descriptions render correctly on PyPI. |