ENG-237 Publish packages to NPM #3785
Conversation
Ref: #000 - api@1.27.2 - @metriport/api-sdk@14.14.2 - @metriport/carequality-cert-runner@1.18.2 - @metriport/carequality-sdk@1.6.2 - @metriport/commonwell-cert-runner@1.26.2 - @metriport/commonwell-jwt-maker@1.24.2 - @metriport/commonwell-sdk@5.9.0 - @metriport/core@1.24.2 - @metriport/ihe-gateway-sdk@0.19.2 - infrastructure@1.22.2 - mllp-server@0.3.2 - @metriport/shared@0.23.2 - utils@1.25.2 Signed-off-by: Rafael Leite <2132564+leite08@users.noreply.github.com>
WalkthroughThis change updates the version numbers of multiple packages from pre-release alpha versions to their corresponding stable release versions. The updates are applied to the main version fields as well as to internal dependencies within the monorepo, ensuring all packages and their dependencies reference stable releases instead of alpha versions. No changes were made to functionality, scripts, metadata, or the declarations of exported or public entities. Changes
Possibly related PRs
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
|
There was a problem hiding this comment.
Actionable comments posted: 6
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📥 Commits
Reviewing files that changed fr 8000 om the base of the PR and between 4b1639d and 2e56a0c.
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (13)
packages/api-sdk/package.json(2 hunks)packages/api/package.json(1 hunks)packages/carequality-cert-runner/package.json(2 hunks)packages/carequality-sdk/package.json(1 hunks)packages/commonwell-cert-runner/package.json(2 hunks)packages/commonwell-jwt-maker/package.json(2 hunks)packages/commonwell-sdk/package.json(2 hunks)packages/core/package.json(1 hunks)packages/ihe-gateway-sdk/package.json(2 hunks)packages/infra/package.json(1 hunks)packages/mllp-server/package.json(1 hunks)packages/shared/package.json(1 hunks)packages/utils/package.json(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: leite08
PR: metriport/metriport#3463
File: packages/api-sdk/src/medical/models/patient.ts:1-1
Timestamp: 2025-03-19T13:58:17.253Z
Learning: When changes are made to SDK packages (`api-sdk`, `commonwell-sdk`, `carequality-sdk`) or `packages/shared` in the Metriport codebase, alpha versions need to be published to NPM before merging the PR.
packages/commonwell-sdk/package.json (1)
Learnt from: leite08
PR: metriport/metriport#3463
File: packages/api-sdk/src/medical/models/patient.ts:1-1
Timestamp: 2025-03-19T13:58:17.253Z
Learning: When changes are made to SDK packages (`api-sdk`, `commonwell-sdk`, `carequality-sdk`) or `packages/shared` in the Metriport codebase, alpha versions need to be published to NPM before merging the PR.
packages/carequality-sdk/package.json (1)
Learnt from: leite08
PR: metriport/metriport#3463
File: packages/api-sdk/src/medical/models/patient.ts:1-1
Timestamp: 2025-03-19T13:58:17.253Z
Learning: When changes are made to SDK packages (`api-sdk`, `commonwell-sdk`, `carequality-sdk`) or `packages/shared` in the Metriport codebase, alpha versions need to be published to NPM before merging the PR.
packages/api-sdk/package.json (1)
Learnt from: leite08
PR: metriport/metriport#3463
File: packages/api-sdk/src/medical/models/patient.ts:1-1
Timestamp: 2025-03-19T13:58:17.253Z
Learning: When changes are made to SDK packages (`api-sdk`, `commonwell-sdk`, `carequality-sdk`) or `packages/shared` in the Metriport codebase, alpha versions need to be published to NPM before merging the PR.
⏰ Context from checks skipped due to timeout of 90000ms (13)
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: check-pr / lint-build-test
- GitHub Check: Analyze (javascript)
🔇 Additional comments (16)
packages/core/package.json (1)
3-3: Bump package version to stable releaseUpdated the
@metriport/coreversion from the pre-release1.24.2-alpha.0to the stable1.24.2, aligning with the PR’s goal of shipping stable releases across the monorepo. Since this package is marked"private": true", this version bump ensures internal consistency.Please verify that CHANGELOG.md or any release notes have been updated to document this version change.
packages/infra/package.json (1)
3-3: Approve version bump to stable release.The version has been correctly updated from the pre-release
1.22.2-alpha.0to the stable1.22.2, matching the broader release plan for PR #3785.
Please verify that this version has been published successfully to the NPM registry and that downstream consumers are referencing the new release.packages/carequality-sdk/package.json (1)
3-3:✅ Verification successful
Version bump is correct; confirm NPM availability.
The version was updated from the alpha pre-release to the stable
1.6.2. Before merging, please verify that this release is published to NPM so consumers can install it without errors.Run:
Expected output:
1.6.2
🏁 Script executed:
#!/bin/bash npm view @metriport/carequality-sdk@1.6.2 versionLength of output: 57
NPM availability confirmed for @metriport/carequality-sdk@1.6.2
Version 1.6.2 is published on npm (npm viewreturned1.6.2). No further action required before merging.packages/mllp-server/package.json (2)
3-3: Approve stable version bump
The version has been correctly updated from the alpha pre-release to the stable release "0.3.2" in line with the PR objectives.
33-34:❓ Verification inconclusive
Verify handling of local file dependencies
The dependencies on"file:packages/core"and"file:packages/shared"may not resolve correctly during an NPM publish. Please ensure your release process replaces these with the published version numbers (e.g.,"@metriport/core": "^1.24.2") or confirm that your registry/workflow supports file-based installs.You can run the following to locate all file-based dependencies across the monorepo:
🏁 Script executed:
#!/bin/bash # Find all file-based deps in package.json files rg '"file:packages/' -tjsonLength of output: 3388
To determine whether your release tooling will handle these file: dependencies automatically, let’s check for monorepo configuration (Yarn Workspaces, Lerna, PNPM, Rush, etc.) in the repo root:
🏁 Script executed:
#!/bin/bash # Check for Yarn Workspaces in root package.json grep -n '"workspaces":' package.json || echo "No 'workspaces' field in root package.json" # Check for common monorepo config files for cfg in lerna.json pnpm-workspace.yaml rush.json; do if [ -f "$cfg" ]; then echo "Found monorepo config: $cfg" fi doneLength of output: 378
To confirm Lerna’s workspace integration and auto‐versioning, let’s inspect your lerna.json:
🏁 Script executed:
#!/bin/bash # Show lerna configuration cat lerna.jsonLength of output: 265
Validate file-based dependencies with Lerna versioning
We’ve confirmed this is a Yarn Workspaces monorepo using Lerna (independent versioning, npm client). File-URL deps like"@metriport/core": "file:packages/core", "@metriport/shared": "file:packages/shared"won’t be published as semver ranges unless your release pipeline runs
lerna version(to bump local packages and update inter-dependencies) followed bylerna publish.• packages/mllp-server/package.json (lines 33–34)
• Similar entries exist in other packages—use your search script to list them all.Please confirm that your CI/CD:
- Invokes
lerna versionbefore publish so these file: specs get rewritten to"^<new-version>".- Or migrate to the
workspace:protocol (e.g."workspace:^1.2.3") to leverage Yarn’s native resolution.packages/shared/package.json (1)
3-3: Promote shared package to stable release
The bump from0.23.2-alpha.0to0.23.2aligns with the coordinated stable rollout. Ensure the new version is published to NPM and that any alpha tags are deprecated before merging.packages/ihe-gateway-sdk/package.json (2)
3-3: Bump SDK package to stable release
Version updated from0.19.2-alpha.0to0.19.2as part of the stable release. Confirm that the new version is published to NPM.
56-56: Align shared dependency to stable version
Updated@metriport/shareddependency from^0.23.2-alpha.0to^0.23.2. This ensures consistency with the promoted shared package.packages/commonwell-sdk/package.json (2)
3-3: Promote CommonWell SDK to stable
Version bump from5.9.0-alpha.0to5.9.0is correct. Verify the stable release has been published to NPM.
63-63: Sync shared dependency to stable release
Changed@metriport/sharedfrom^0.23.2-alpha.0to^0.23.2, matching the shared package promotion.packages/commonwell-cert-runner/package.json (2)
3-3: Upgrade cert-runner to stable version
Bumped from1.26.2-alpha.0to1.26.2. Confirm that this stable version is available on NPM.
45-45: Update CommonWell SDK dependency
Dependency on@metriport/commonwell-sdkmoved from^5.9.0-alpha.0to^5.9.0, ensuring all runners reference the stable SDK.packages/carequality-cert-runner/package.json (2)
3-3: Promote Carequality cert-runner to stable
Version updated from1.18.2-alpha.0to1.18.2. Please verify the stable package is published to NPM.
44-45: Align dependencies to stable releases
@metriport/ihe-gateway-sdk:^0.19.2@metriport/shared:^0.23.2Both changes correctly point at the newly promoted stable packages.
packages/commonwell-jwt-maker/package.json (1)
44-44:✅ Verification successful
Align internal SDK dependency to stable release
The dependency on@metriport/commonwell-sdkhas been updated to^5.9.0, matching the stable release. Verify that@metriport/commonwell-sdk@5.9.0is published to avoid unresolved dependencies.
🏁 Script executed:
npm view @metriport/commonwell-sdk@5.9.0 versionLength of output: 56
Verified @metriport/commonwell-sdk@5.9.0 is published
The dependency update matches the stable release andnpm view @metriport/commonwell-sdk@5.9.0confirms version 5.9.0 is available. Ready to merge.packages/api-sdk/package.json (1)
61-62:✅ Verification successful
Update internal dependencies to stable versions
Dependencies on@metriport/commonwell-sdk(^5.9.0) and@metriport/shared(^0.23.2) have been synced to stable releases. Ensure both are published on NPM to prevent installation issues.
🏁 Script executed:
npm view @metriport/commonwell-sdk@5.9.0 version npm view @metriport/shared@0.23.2 versionLength of output: 107
Approve: Stable dependency versions are published
I’ve confirmed that both@metriport/commonwell-sdk@5.9.0and@metriport/shared@0.23.2are available on npm. No further action is required—merging is safe.• File:
packages/api-sdk/package.json(lines 61–62)
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "api", | |||
| "version": "1.27.2-alpha.0", | |||
| "version": "1.27.2", | |||
There was a problem hiding this comment.
Ensure package can be published
The version bump to 1.27.2 aligns with the stable release, but since this package is marked "private": true, npm will refuse to publish it. Please update to "private": false (or remove the field) so the package can be published as intended.
Recommended diff:
- "private": true,
+ "private": false,📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "version": "1.27.2", | |
| "version": "1.27.2", | |
| - "private": true, | |
| + "private": false, |
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "infrastructure", | |||
| "version": "1.22.2-alpha.0", | |||
| "version": "1.22.2", | |||
| "private": true, | |||
There was a problem hiding this comment.
Ensure package is publishable.
The "private": true flag prevents this package from being published to NPM. Since PR #3785 intends to publish infrastructure 1.22.2, please remove or update this field to allow publishing.
Suggested fix:
- "private": true,
+ "private": false,📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "private": true, | |
| "private": false, |
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "utils", | |||
| "version": "1.25.2-alpha.0", | |||
| "version": "1.25.2", | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Confirm publication settings for the utils package
The version bump to "1.25.2" is correct for a stable release. However, the package is still marked "private": true", which will block any attempt to publish it to NPM. Since this PR’s objective includes publishing utils to the registry, please remove or set "private": false, or clarify if utils should remain private.
Let's verify whether the private flag in packages/utils/package.json is set to true:
🏁 Script executed:
#!/bin/bash
# Check for the "private" field in the utils package.json
rg '"private"\s*:\s*' -n packages/utils/package.jsonLength of output: 75
Remove or Disable the private Flag to Enable Publishing
The packages/utils/package.json is currently marked as private, which will prevent it from being published to npm. Since this PR intends to release version 1.25.2 of utils, please remove the private field or set it to false.
• File: packages/utils/package.json
Line 5
Suggested change:
- "private": true,
+ "private": false,📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "version": "1.25.2", | |
| "version": "1.25.2", | |
| "private": false, |
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "mllp-server", | |||
| "version": "0.3.2-alpha.0", | |||
| "version": "0.3.2", | |||
| "description": "MLLP server that reads HL7 messages off of a raw tcp connection", | |||
| "main": "app.js", | |||
| "private": true, | |||
There was a problem hiding this comment.
Blocker: Remove private field before publishing
The "private": true setting will prevent npm publish from succeeding. Since mllp-server is intended to be published to NPM (per PR summary), please remove this line.
Suggested diff:
- "private": true,📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "private": true, |
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "@metriport/commonwell-jwt-maker", | |||
| "version": "1.24.2-alpha.0", | |||
| "version": "1.24.2", | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Promote package to stable release
Updating the version from 1.24.2-alpha.0 to 1.24.2 correctly prepares this package for stable publication. Ensure you’ve created the corresponding Git tag and that the NPM registry reflects 1.24.2.
Consider running:
🏁 Script executed:
npm view @metriport/commonwell-jwt-maker@1.24.2 versionLength of output: 64
🏁 Script executed:
#!/bin/bash
# Verify that the Git tag for v1.24.2 exists on the remote
git fetch --tags
git ls-remote --tags origin | grep -E "refs/tags/(v?1\.24\.2)$"Length of output: 65555
Missing Git tag for v1.24.2
The npm registry shows version 1.24.2, but I don’t see a corresponding Git tag on the remote. Please create and push the tag before finalizing this release. For example:
git tag v1.24.2
git push origin v1.24.2| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "@metriport/api-sdk", | |||
| "version": "14.14.2-alpha.0", | |||
| "version": "14.14.2", | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Promote API SDK to stable release
Bumping from 14.14.2-alpha.0 to 14.14.2 prepares this SDK for production use. Confirm the 14.14.2 Git tag exists and that the package has been published to NPM.
🏁 Script executed:
npm view @metriport/api-sdk@14.14.2 versionLength of output: 53
🏁 Script executed:
#!/bin/bash
set -eo pipefail
# Ensure latest tags are available
git fetch --tags
# Check for a tag matching 14.14.2 or v14.14.2
git tag -l | grep -E "^v?14\.14\.2$" || {
echo "No matching git tag found for 14.14.2"
exit 1
}Length of output: 170
Git tag missing for release 14.14.2
The NPM package @metriport/api-sdk@14.14.2 is published, but I couldn’t find a corresponding Git tag. Please create and push a 14.14.2 (or v14.14.2) tag before merging.
• Verify locally:
git fetch --tags
git tag -l | grep -E "^v?14\.14\.2$"• If missing, create and push:
git tag 14.14.2
git push origin 14.14.2
Dependencies
Description
Summary by CodeRabbit