microsoft / microsoft/beachball
Prohibit unsupported bump types based on API surface changes
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 815
- Forks
- 93
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 12
Description
When someone removes a named export, typing or not, this is a breaking change for consumers of that named export. This happens far more often than we'd like. Beachball has an opportunity to detect this and enforce only valid upgrade types.
Something like:
Pull api.json from master, compare with branch, determine if named exports are missing or functions change api signatures and disallow patches and minors.
Detect if a new export or function argument was added, disallow patches.
Allow for a cli argument way to override enforcement in the case there is some reasonable change it detected incorrectly.
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 how Beachball reads api.json from master and the current branch, then identify the existing bump-type validation and CLI argument handling. Compare removed exports and changed signatures with added exports or arguments, and define the override behavior; done means invalid patch or minor bumps are rejected while valid changes and explicit overrides work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, typescript
- Domain
- api, release, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100