Skip to content

Add CI coverage for npm README install and release-surface drift #177

@luoyuctl

Description

@luoyuctl

Background

The repository has npm wrapper documentation, but the package is not published yet. Current release-surface CI checks README, Homebrew, site metadata, and the demo report, while npm/README.md can still drift independently.

Evidence

  • Latest release is v0.4.6.
  • npm view agenttrace version --json currently returns npm E404.
  • origin/master npm/README.md still presents an npm install -g agenttrace block and includes AGENTTRACE_RELEASE_TAG=v0.4.2 node install.js in maintainer checks.
  • scripts/ci/check-release-surfaces.sh does not scan npm/README.md for stale versions or unavailable active install paths.
  • PR Add growth assets and npm launch docs #156 improves the npm README copy, but the current CI gates do not prevent this class of drift from returning later.

User value

Users and maintainers should not be pointed at an unavailable npm install path or stale release tag when checking package-wrapper docs.

Adoption rationale

Keeping package docs under the same release-surface validation reduces install confusion and keeps public package-channel messaging consistent while npm publication remains undecided.

Suggested scope

  • Extend release/docs CI validation so npm/README.md is checked for stale explicit release tags.
  • While npm remains unpublished, fail if npm/README.md presents npm install -g agenttrace as an active install method instead of a future/after-publish path.
  • Keep the check small and deterministic; do not publish npm or change package registry state.

Non-goals

Acceptance criteria

Suggested lane

lane/quality

Risk

Low to medium. The check should avoid blocking future npm publication once a maintainer records the package-channel decision and the package is actually published.

Source

Product release-surface audit on 2026-05-10, npm view agenttrace version --json, npm/README.md, and scripts/ci/check-release-surfaces.sh.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions