Skip to content

Fix npm package README publishing#1256

Open
max-voloshyn wants to merge 2 commits into
mainfrom
npm-package-readmes
Open

Fix npm package README publishing#1256
max-voloshyn wants to merge 2 commits into
mainfrom
npm-package-readmes

Conversation

@max-voloshyn
Copy link
Copy Markdown
Collaborator

@max-voloshyn max-voloshyn commented May 29, 2026

Summary

  • Add a short package-root README for @owox/api-client so npm displays install guidance without duplicating the primary docs.
  • Replace the package-external relative @owox/ctl docs link with a direct docs.owox.com URL.
  • Explicitly include package READMEs in both npm files lists and add regression tests for package-safe README links/content.

Root Cause

@owox/api-client did not have a README.md in its package directory, so the published npm package had no README. @owox/ctl shipped a README, but its documentation link pointed outside the package via ../../docs/api/owox-ctl.md, which breaks when rendered on npm.

Review Follow-up

The package READMEs now use public docs.owox.com documentation links. The @owox/api-client README is intentionally minimal and links to the canonical guide, API key docs, and OpenAPI docs instead of copying guide content into the npm package README.

Validation

  • npm --cache /private/tmp/owox-npm-cache run test -w @owox/ctl
  • npm --cache /private/tmp/owox-npm-cache run test -w @owox/api-client
  • npm --cache /private/tmp/owox-npm-cache run lint -w @owox/ctl
  • npm --cache /private/tmp/owox-npm-cache run lint -w @owox/api-client
  • npm --cache /private/tmp/owox-npm-cache run format:check -w @owox/ctl
  • npm --cache /private/tmp/owox-npm-cache run format:check -w @owox/api-client
  • npm --cache /private/tmp/owox-npm-cache run lint:md:all -- apps/ctl/README.md packages/api-client/README.md
  • npm pack --dry-run --json --ignore-scripts --cache /private/tmp/owox-npm-cache -w @owox/ctl
  • npm pack --dry-run --json --ignore-scripts --cache /private/tmp/owox-npm-cache -w @owox/api-client

Comment thread apps/ctl/README.md Outdated
Comment thread packages/api-client/README.md Outdated
@max-voloshyn max-voloshyn marked this pull request as ready for review May 29, 2026 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant