ni / ni/measurement-plugin-python
Add automated API compatibility checks to GitHub PR workflow
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 21
- Forks
- 20
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 3
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 reviewing the repository's GitHub PR workflow and the proposed Griffe tool documentation. Define how API compatibility should be checked for pull requests; the work is done when compatibility-breaking changes are detected before merging into main.
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
- 45/100