-
-
Notifications
You must be signed in to change notification settings - Fork 7
Document TypeScript npm release prerequisites and flow #7
Copy link
Copy link
Closed
Labels
area:sdk-typescriptTypeScript SDK implementation and toolingTypeScript SDK implementation and toolingdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Summary
We added a tag-triggered npm publish workflow for the TypeScript package, but contributor docs do not yet explain required repository secrets and release steps.
Why this is useful
New contributors and maintainers can accidentally trigger failed release runs without knowing the NPM_TOKEN requirement or version/tag matching rule.
Proposed work
Update docs to include TypeScript release prerequisites and flow:
- Mention
NPM_TOKENin repository secrets. - Explain that tag
vX.Y.Zmust matchclients/typescript/package.jsonversion. - Provide a short release checklist in
CONTRIBUTING.md.
Acceptance criteria
CONTRIBUTING.mdcontains a concise TypeScript release section.- Release prerequisites (
NPM_TOKEN) are explicitly documented. - Tag/version matching rule is documented.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area:sdk-typescriptTypeScript SDK implementation and toolingTypeScript SDK implementation and toolingdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers