Skip to content

Guard root README npm availability wording #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luoyuctl merged 1 commit into from
May 10, 2026
Merged

Guard root README npm availability wording #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Windows:
iwr -useb https://raw.githubusercontent.com/luoyuctl/agenttrace/master/install.ps1 | iex
```

The npm wrapper is also available as `agenttrace` after each release is published.
The npm wrapper package is not published yet; use the installer, Homebrew, or Go install paths above for now.

## Common workflows

Expand Down
6 changes: 6 additions & 0 deletions scripts/ci/check-release-surfaces.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ if grep -Eqi "not been published yet|registry 404|until the first publish" npm/R
fail "npm README must not present npm install as active while the package is unpublished"
fi

if grep -Eqi "not been published yet|registry 404|until the first publish" npm/README.md &&
grep -Eqi "npm wrapper is also available|npm install -g agenttrace" README.md &&
! grep -Eqi "npm wrapper package is not published yet|after the package is published" README.md; then
fail "README must not present npm as active while the package is unpublished"
fi

if ! grep -q "<div class=\"meta\">v$version" site/demo-report.html &&
! grep -qi "static sample data" site/demo-report.html; then
fail "site demo report must use current version metadata or clearly identify static sample data"
Expand Down