OpenAPITools / OpenAPITools/openapi-diff
Do not fail with breaking changes when major version is bumped
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
Hello!
I was wondering if it makes sense to pass the diff check if there are breaking changes, but the major version has been bumped. Right now, I am planning to use this as a required workflow on GitHub PRs and I want to give developers the opportunity to get around the check if they bump the version.
Would love this as a potential built in feature or option when running.
Thanks
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 tracing the diff check and the entry point used when running it in a required GitHub PR workflow. Determine how the current check detects breaking changes and how the compared specifications expose their major versions; done means a major-version bump can explicitly allow the check to pass, with coverage for the new behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, ci-cd
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100