Auto ts client versioning from git tag on publish#1195
Merged
Conversation
Signed-off-by: yaleMemVerge <yale.sun@memverge.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the TypeScript client npm publish failure (issue #1184) by replacing the hardcoded version in package.json with a 0.0.0-development placeholder and adding a CI step to automatically derive the version from the git release tag at publish time, consistent with how the Python packages already work via setuptools-scm.
Changes:
- Set
package.jsonandpackage-lock.jsonversion to0.0.0-developmentas a CI-overridden placeholder. - Added a workflow step in
ts-client-publish.ymlto inject the version from the git tag (GITHUB_REF_NAME) for release events, or from a manual input forworkflow_dispatchevents. - Added
workflow_dispatchtrigger with aversioninput to enable manual testing of the publish workflow.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
packages/ts-client/package.json |
Version changed from 0.2.5 to 0.0.0-development placeholder |
packages/ts-client/package-lock.json |
Version updated to match the placeholder in package.json |
.github/workflows/ts-client-publish.yml |
Added workflow_dispatch trigger and version-setting step that derives version from git tag or manual input |
Files not reviewed (1)
- packages/ts-client/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
22 tasks
jealous
approved these changes
Mar 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of the change
Fix TypeScript client failing to publish to npm on release because the version was hardcoded in
package.json. Now the version is automatically derived from the git release tag, consistent with how Python packages work via setuptools-scm.Description
package.json/package-lock.json: version set to0.0.0-developmentas a placeholder; CI always overrides it at publish time.ts-client-publish.yml: added a step to inject version from the git tag (GITHUB_REF_NAME) beforenpm publish. Also addedworkflow_dispatchtrigger for manual testing after merge.Fixes/Closes
Fixes #1184
Type of change
How Has This Been Tested?
Triggered manually via Actions → Publish TypeScript Client Package to npm → Run workflow, with a test version input (e.g. 0.3.0). Confirmed version was correctly set and the build and publish steps completed successfully.
Test Results: To be verified after merge via workflow_dispatch.
Checklist
Maintainer Checklist
Screenshots/Gifs
N/A