element-hq / element-hq/synapse
Run `twine check` as part of CI or release process
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 600
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 51
Description
This issue has been migrated from [#9186](https://github.com/matrix-org/synapse/issues/9186).
---
A missing colon resulted in our changelog being invalid reStructuredText and thus failing the PyPI upload for 1.26.0rc1
See https://github.com/matrix-org/synapse/commit/4c37d2acd58f9cbcdc262d25a75f8b38c50ed7f9
We should run `twine check` somewhere to catch these errors before tagging the release.
Contributor guide
Research direction
Locate the CI or release process that builds and uploads the Python package, then review where a pre-release validation step can run. Use the reported invalid reStructuredText changelog and the `twine check` command as the acceptance case; done means the check runs before tagging or uploading and catches packaging metadata errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, release
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100