Add automated API compatibility checks to GitHub PR workflow
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 592
- Forks
- 199
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 10
Description
Problem to Solve
Adding some sort of API compatibility checks to the GitHub PR workflow would prevent compatibility-breaking changes from being merged into main. Currently, we rely on internal test suites to catch this after the change is merged into main.
Proposed Solution
Use a static analysis tool, such as:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the GitHub PR workflow and reviewing how the Python package is built and tested there. Evaluate the proposed Griffe-based compatibility check against the current workflow. Done means pull requests automatically detect compatibility-breaking API changes before merge.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- api, ci-cd
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100