temporalio / temporalio/sdk-typescript
[Feature Request] Formally validate public API modification between releases
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- TypeScript
- Stars
- 917
- Forks
- 224
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 43
Description
Is your feature request related to a problem? Please describe.
At the moment, it is very difficult to identify changes to exported members signatures from our SDK packages. This leads to two negative consequences:
- Risk of unexpected breaking changes in patch or minor releases;
- Risk of exposing members that were never meant for public usage (thus increasing even more the risk of further breaking changes).
Describe the solution you'd like
Use a tool run in CICD that:
- Identify the exact set of publicly exported APIs
- Reports changes in these exported APIs relative to the appropriate baseline
Additional context
Microsoft's API Extractor can probably be used for this.
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 SDK package exports and the repository's CI/CD configuration, then evaluate Microsoft's API Extractor as suggested. Done means CI identifies the exact publicly exported APIs and reports changes against the appropriate release baseline.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, ci-cd
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100