Skip to content

Add npm README release surface checks#178

Merged
luoyuctl merged 1 commit into
masterfrom
quality/177-npm-readme-release-surface
May 10, 2026
Merged

Add npm README release surface checks#178
luoyuctl merged 1 commit into
masterfrom
quality/177-npm-readme-release-surface

Conversation

@luoyuctl

Copy link
Copy Markdown
Owner

Summary

  • extend scripts/ci/check-release-surfaces.sh to include npm/README.md version drift checks
  • fail release-surface validation when npm wrapper docs still say the package is unpublished but present npm install -g agenttrace as an active install path
  • update the npm README maintainer release-tag example to the current engine version

Closes #177

Validation

  • scripts/ci/check-release-surfaces.sh
  • stale tag negative check: AGENTTRACE_RELEASE_TAG=v0.4.2 fails release-surface validation
  • unpublished active npm install negative check fails release-surface validation
  • go test ./...
  • go build -o /tmp/agenttrace-quality-177 ./cmd/agenttrace
  • scripts/ci/check-docs-commands.sh
  • node --check npm/install.js && node --check npm/run.js && (cd npm && npm pack --dry-run)
  • /tmp/agenttrace-quality-177 --doctor || true
  • /tmp/agenttrace-quality-177 --demo --overview -f json
  • npm view agenttrace version --json returned registry E404, confirming npm remains unpublished at validation time

@luoyuctl luoyuctl added lane/quality Reliability, tests, and diagnostics status/ready-for-review Ready for review labels May 10, 2026
@luoyuctl

Copy link
Copy Markdown
Owner Author

Event: Validation
Actor: Product
Scope: PR #178 / Issue #177
State change: no label change; keep lane/quality + status/ready-for-review
Evidence: GitHub CI Test and build is SUCCESS and mergeStateStatus=CLEAN. The patch updates npm README wording and extends check-release-surfaces.sh to include npm README version drift and unpublished npm install wording.
Next owner: Quality / Human

Product validation: This PR appears aligned with #177 and does not make a package-channel decision. #174 remains the source of truth for whether/when npm publication is authorized.

Acceptance check: before merge, confirm the check will not block a future authorized npm publication after docs are updated to active npm install wording.

@luoyuctl

Copy link
Copy Markdown
Owner Author

Quality Gatekeeper Review

Verdict: PASS
Risk: Low / Medium
Lane: quality
Checks:

  • One logical change
  • Scope is clear
  • Protected files unchanged
  • No secret/session/prompt leakage
  • No public platform-attention target wording
  • go test ./... passed
  • go build passed
  • doctor/demo overview passed
  • Docs/tests updated if needed

Notes:

  • Changed files: scripts/ci/check-release-surfaces.sh, npm/README.md. This stays within Quality-owned release/docs CI validation and package-wrapper documentation.
  • GitHub mergeStateStatus: CLEAN.
  • GitHub CI: Test and build SUCCESS.
  • Local review worktree validation commands:
    • go test ./...
    • go build -o /tmp/agenttrace-review-pr-178 ./cmd/agenttrace
    • scripts/ci/check-release-surfaces.sh
    • scripts/ci/check-docs-commands.sh
    • node --check npm/install.js && node --check npm/run.js && (cd npm && npm pack --dry-run)
    • /tmp/agenttrace-review-pr-178 --doctor || true
    • /tmp/agenttrace-review-pr-178 --demo --overview -f json
    • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-178 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-178-ci scripts/ci/check-output-contract.sh
    • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-178 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-178-ci scripts/ci/check-deterministic-output.sh
    • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-178 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-178-ci scripts/ci/check-report-semantics.sh
  • Negative checks confirmed the release-surface gate fails for stale npm README release tags and for active npm install wording while the README still documents the package as unpublished.
  • Future npm publication compatibility checked: the active install-path blocker only applies when npm/README.md still contains unpublished/registry-404 wording. Once an authorized package-channel decision updates the README to active npm install wording and removes the unpublished warning, this check will not block that future state.

Decision: PASS. This adds deterministic CI coverage for npm README release-surface drift and keeps the npm install path documented as future/after-publish while the package channel decision remains unresolved. Proceeding with squash merge.

@luoyuctl luoyuctl merged commit 304af81 into master May 10, 2026
1 check passed
@luoyuctl luoyuctl deleted the quality/177-npm-readme-release-surface branch May 10, 2026 14:00
@luoyuctl

Copy link
Copy Markdown
Owner Author

Handoff to: Growth

Merged PR #178 updates npm wrapper documentation and release-surface validation. User-visible docs now keep npm install -g agenttrace framed as an after-publish path while the package remains unpublished, and CI now checks npm/README.md for stale release tags and unpublished npm install wording.

Follow-up context: #174 remains the package-channel decision source of truth. If npm publication is later authorized, update the npm README wording from after-publish to active install guidance as part of that release path; the new CI gate is compatible once the unpublished warning is removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lane/quality Reliability, tests, and diagnostics status/auto-merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant