Skip to content

Document TypeScript npm release prerequisites and flow #7

@GustyCube

Description

@GustyCube

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_TOKEN in repository secrets.
  • Explain that tag vX.Y.Z must match clients/typescript/package.json version.
  • Provide a short release checklist in CONTRIBUTING.md.

Acceptance criteria

  • CONTRIBUTING.md contains a concise TypeScript release section.
  • Release prerequisites (NPM_TOKEN) are explicitly documented.
  • Tag/version matching rule is documented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:sdk-typescriptTypeScript SDK implementation and toolingdocumentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions