fix(ts-client): include readme in published package#1340
Merged
sscargal merged 1 commit intoMay 13, 2026
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Ensures the published @memmachine/client npm package includes its README so documentation appears on the npm package page and in the packed tarball.
Changes:
- Expands the
fileswhitelist inpackages/ts-client/package.jsonto includeREADME.mdin addition todist.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
@haosenwang1018 thank you for the pull request submission. Please sign your commits, resolve the unit test failures, and review the CoPilot feedback. You only need to resolve the relevant items. Thanks. |
Add `README.md` to the `files` whitelist in `packages/ts-client/package.json` so the package README ships in the published tarball and renders on the npm package page. Note: the Copilot review comment about README path resolution is not applicable here — `packages/ts-client/README.md` already exists alongside `package.json`, so the entry resolves correctly and the README is included in `npm pack` output. Refs: MemMachine#1340 Co-authored-by: Steve Scargall <steve.scargall@gmail.com> Signed-off-by: Steve Scargall <37674041+sscargal@users.noreply.github.com>
sscargal
force-pushed
the
fix/ts-client-publish-readme
branch
from
6fdfad3 to
610b59c
Compare
jealous
approved these changes
May 13, 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
Ensure the published
@memmachine/clientnpm package includes its README so the npm package page and tarball contain the client usage/docs content.Description
Follow-up to #1181
packages/ts-client/package.jsoncurrently restricts the published file set todist, which means the package README is omitted from the published artifact.This change updates the
filesfield to includeREADME.mdalongsidedist.Type of change
How Has This Been Tested?
Test command:
cd packages/ts-client && npm pack --dry-runVerified that
README.mdis now included in the tarball contents.Checklist
Maintainer Checklist