feat(skills): ship skills in @clickhouse/client package and add E2E packaging test by peter-leonov-ch · Pull Request #682 · ClickHouse/clickhouse-js

peter-leonov-ch · 2026-04-29T15:13:58Z

Summary

https://github.com/antfu/skills-npm/blob/main/PROPOSAL.md#for-package-authors

Copies skills/ into @clickhouse/client at pack time via prepack, so skills
are available under node_modules/@clickhouse/client/skills/ after npm install
Declares the skill in the agents.skills field of the package manifest for
discovery tools that scan node_modules
Adds a skills-e2e workflow that packs all three packages from source, installs
them in a fresh app, and asserts the skill files and manifest entries are present

What's in the tarball

skills/clickhouse-js-node-troubleshooting/
SKILL.md
reference/*.md
evals/evals.json

Skills live at the repo root so they stay visible across all packages; prepack
copies them into the package directory before packing (same pattern as README/LICENSE).

codecov · 2026-04-29T15:16:35Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copilot

Pull request overview

Adds packaging support so the root skills/ directory is shipped inside the published @clickhouse/client tarball and introduces a GitHub Actions E2E workflow to verify the packaged artifacts expose the skill files + manifest metadata.

Changes:

Update @clickhouse/client packaging to include a skills/ directory and declare it under package.json -> agents.skills.
Add a new E2E “skills” fixture app plus a Node script that validates installed package contents.
Add a skills-e2e GitHub Actions workflow that builds, packs, installs the tarballs, and runs the content checks.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`packages/client-node/package.json`	Ships `skills/` in the Node package tarball and exposes skill metadata via `agents.skills`; updates `prepack` to copy root `skills/`.
`.github/workflows/skills-e2e.yml`	New CI workflow that packs the workspaces and validates skill availability after install.
`tests/e2e/skills/check.js`	E2E verification script asserting skill files + manifest entries exist in installed `@clickhouse/client`.
`tests/e2e/skills/package.json`	Minimal fixture app manifest for the E2E packaging test.
`tests/e2e/skills/.gitignore`	Ignores install artifacts for the fixture app.
`.gitignore`	Ignores generated `packages/*/skills/` directories created during `prepack`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

…k steps Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

This PR makes “skills” distributable as part of the published @clickhouse/client (Node) package and adds a GitHub Actions E2E workflow to verify packaging/install behavior from packed tarballs.

Changes:

Package skills/ into @clickhouse/client during prepack and include it in published files.
Add an agents.skills manifest entry in @clickhouse/client for discovery tools.
Add a skills-e2e workflow + minimal E2E test app that installs packed tarballs and verifies skills presence.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`packages/client-node/package.json`	Includes `skills` in `files`, adds `agents.skills`, and copies repo-root `skills/` at pack time.
`.gitignore`	Ignores generated/copied `packages/*/skills/` artifacts.
`.github/workflows/skills-e2e.yml`	New CI workflow that packs from source and verifies skills packaging in a fresh install.
`tests/e2e/skills/package.json`	Minimal E2E “app” used for installation checks.
`tests/e2e/skills/check.js`	Asserts installed package has skills directory and `agents.skills` entry.
`tests/e2e/skills/.gitignore`	Ignores E2E install artifacts (node_modules, lockfile).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

This PR makes repository “skills” available to consumers of @clickhouse/client by packaging skills/ into the published tarball and advertising the shipped skill via package.json, and adds a GitHub Actions E2E workflow to validate the packaging outcome in a fresh install.

Changes:

Copy repo-root skills/ into packages/client-node during prepack, include it in published files, and declare the shipped skill in agents.skills.
Add a skills-e2e GitHub Actions workflow that builds + packs workspace tarballs, installs them in an isolated test app, and asserts skill files/metadata exist.
Add a small E2E test fixture under tests/e2e/skills/ to validate installation, skill visibility, and skills-npm discovery/symlinking.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`tests/e2e/skills/package.json`	Defines an isolated E2E project and installs `skills-npm` to validate skill discovery.
`tests/e2e/skills/check.js`	Node script asserting packaged skill files and manifest metadata exist post-install.
`tests/e2e/skills/.gitignore`	Ignores generated install artifacts for the E2E fixture.
`packages/client-web/package.json`	Adds a `pack` script for workspace-driven packing in CI.
`packages/client-node/package.json`	Ships `skills/`, declares `agents.skills`, and copies skills into the package at `prepack`.
`packages/client-common/package.json`	Adds a `pack` script for workspace-driven packing in CI.
`.gitignore`	Ignores generated `packages/*/skills/` copies created during packing.
`.github/workflows/skills-e2e.yml`	New CI workflow to validate skills are present/declared in packed tarballs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Adds “agent skills” packaging support to the Node client so skill metadata/files are shipped inside the published @clickhouse/client tarball, and introduces an E2E workflow that validates the packed artifacts in a fresh install.

Changes:

Copy repo-root skills/ into packages/client-node during prepack, include it in files, and expose it via package.json agents.skills.
Add pack scripts to all workspaces so CI can npm pack each package uniformly.
Add a skills-e2e GitHub Actions workflow + minimal E2E fixture app/assertions to verify packaged skills + manifest metadata.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tests/e2e/skills/package.json	Adds an E2E fixture app and runs `skills-npm` via lifecycle script.
tests/e2e/skills/check.js	Adds assertions that packaged skills + `agents.skills` metadata are present and that `skills-npm` creates symlinks.
tests/e2e/skills/.gitignore	Ignores E2E fixture install artifacts (node_modules, lockfile, generated symlinks).
packages/client-web/package.json	Adds a `pack` script for workspace packing in CI.
packages/client-node/package.json	Ships `skills/` in `@clickhouse/client` tarball and declares `agents.skills`; updates `prepack`; adds `pack`.
packages/client-common/package.json	Adds a `pack` script for workspace packing in CI.
.gitignore	Ignores generated `packages/*/skills/` directories created during packing.
.github/workflows/skills-e2e.yml	Adds workflow that builds, packs, installs packed tarballs into fixture app, and runs checks.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

This PR adds “agent skills” packaging to the @clickhouse/client Node package (copying repo-root skills/ into the published tarball and advertising them via package.json) and introduces GitHub Actions E2E checks to validate skill availability after install/pack.

Changes:

Package skills/ into @clickhouse/client during prepack and declare it under agents.skills.
Add a new e2e-skills workflow that packs workspaces, installs the tarballs in a fresh project, and asserts skills/metadata presence.
Add/adjust an e2e-install tiny-project scaffold and update its workflow working directory.

Reviewed changes

Copilot reviewed 8 out of 14 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tests/e2e/skills/package.json	Adds an E2E project that runs `skills-npm` during install.
tests/e2e/skills/check.js	Verifies `@clickhouse/client` ships `skills/` and declares `agents.skills`; checks `skills-npm` output.
tests/e2e/skills/.gitignore	Ignores local E2E artifacts and generated npm skill links.
tests/e2e/install/tsconfig.json	Adds TS config for the tiny-project E2E install/typecheck job.
tests/e2e/install/src/index.ts	Adds runtime checks against npm dist-tags and basic client instantiation.
tests/e2e/install/package.json	Defines the tiny-project E2E harness dependencies (TypeScript + Node types).
tests/e2e/install/package-lock.json	Locks tiny-project dev dependencies.
tests/e2e/install/.gitignore	Ignores tiny-project `node_modules`.
packages/client-web/package.json	Adds a `pack` script to support workspace packing in CI.
packages/client-node/package.json	Includes `skills/` in published files, declares `agents.skills`, and copies repo-root `skills/` on `prepack`.
packages/client-common/package.json	Adds a `pack` script to support workspace packing in CI.
.gitignore	Ignores generated `packages/*/skills/` copies created during packing.
.github/workflows/e2e-skills.yml	New workflow to validate packed tarballs include skills and metadata.
.github/workflows/e2e-install.yml	Updates workflow default working directory for the tiny-project E2E job.

Comments suppressed due to low confidence (1)

.github/workflows/e2e-install.yml:20

The workflow’s push path filter references .github/workflows/e2e.yml, but that file doesn’t exist in the repo (this workflow is e2e-install.yml). As a result, pushes that modify this workflow won’t trigger it. Update on.push.paths to include .github/workflows/e2e-install.yml (or the correct workflow filename).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

`AGENTS.md` had drifted from reality after PRs #662–#712: it claimed `examples/web` has no `performance/` folder, pointed at a placeholder docs path, and said nothing about the `skills/` directory or the `.claude/skills/setup/` skill that replaced `copilot-setup-steps.yml`. ## Summary - **Examples › `performance/`** — drop the "no `performance/` folder under `examples/web`" claim; #701 added one for browser-safe streaming. - **Log-message docs guidance** — point at the real `docs/` layout from #677 (`docs/socket_hang_up_econnreset.md`, `docs/howto/`) instead of a fictional `docs/example-log-message.md`. The example URL in the snippet now also resolves to a real page (`docs/socket_hang_up_econnreset.md`). - **New `Skills` section** — documents the repo-root `skills/` directory (#681, #682, #702): `client-node`'s `prepack` ships it via `@clickhouse/client`, the `agents.skills` field of `packages/client-node/package.json` declares which skills are discoverable, and the `Skills E2E` workflow (`.github/workflows/e2e-skills.yml`, backed by `tests/e2e/skills/check.js`) asserts the packaged tarball contains the declared skills. Routes contributors to `.claude/skills/setup/SKILL.md` (#705) instead of re-introducing `copilot-setup-steps.yml`. - **`agents.skills` manifest** — adds `clickhouse-js-node-coding` alongside `clickhouse-js-node-troubleshooting` so both shipped skills are discoverable to downstream tooling. `tests/e2e/skills/check.js` is extended to verify both skills land in the packaged `@clickhouse/client` tarball. - **New `Embedded docs` section** — surfaces `docs/` as the preferred home for pages linked from log messages. - **CHANGELOG guidance** — aligns with the PR template: entry goes in the PR description and is folded into `CHANGELOG.md` at release time. Documentation refresh plus a small manifest/test change to make the second shipped skill discoverable. ## Checklist - [x] A human-readable description of the changes was provided to include in CHANGELOG --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: peter-leonov-ch <209667683+peter-leonov-ch@users.noreply.github.com> Co-authored-by: Peter Leonov <peter.leonov@clickhouse.com>

peter-leonov-ch added 4 commits April 29, 2026 17:02

set up packaging skills

118b184

minimal app

4c2658b

simle check

4d9cbd0

workflow

2802c9c

Copilot AI review requested due to automatic review settings April 29, 2026 15:13

peter-leonov-ch requested a review from mshustov as a code owner April 29, 2026 15:13

github-advanced-security AI found potential problems Apr 29, 2026

View reviewed changes

Comment thread .github/workflows/e2e-skills.yml Fixed

Copilot started reviewing on behalf of peter-leonov-ch April 29, 2026 15:14 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Comment thread packages/client-node/package.json Outdated

Comment thread tests/e2e/skills/check.js Outdated

Comment thread .github/workflows/e2e-skills.yml

Potential fix for pull request finding

de4bccc

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 29, 2026 15:19

Potential fix for pull request finding

c74ddd9

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot started reviewing on behalf of peter-leonov-ch April 29, 2026 15:19 View session

peter-leonov-ch and others added 2 commits April 29, 2026 17:20

Potential fix for pull request finding

937a143

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

chore: add pack script to each workspace and consolidate workflow pac…

d148f83

…k steps Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Comment thread packages/client-node/package.json

Comment thread tests/e2e/skills/check.js

peter-leonov-ch added 3 commits April 29, 2026 17:56

install skills-npm

bb46f7c

check

c89fe3e

follow the readme

ca22fa0

github-advanced-security AI found potential problems Apr 29, 2026

View reviewed changes

Comment thread .github/workflows/e2e-skills.yml Fixed

github-code-quality Bot found potential problems Apr 29, 2026

View reviewed changes

Comment thread tests/e2e/skills/check.js Fixed

peter-leonov-ch added 3 commits April 29, 2026 18:00

as per readme

75da45c

invert and order

726c6e3

fix

eb93b8e

Copilot AI review requested due to automatic review settings April 29, 2026 16:20

github-advanced-security AI found potential problems Apr 29, 2026

View reviewed changes

Comment thread .github/workflows/e2e-skills.yml Fixed

Copilot started reviewing on behalf of peter-leonov-ch April 29, 2026 16:21 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Comment thread tests/e2e/skills/check.js Outdated

Comment thread tests/e2e/skills/package.json

Comment thread .github/workflows/e2e-skills.yml

update

d617d3d

peter-leonov-ch and others added 2 commits April 29, 2026 18:25

fix the agent name

bc13731

Potential fix for pull request finding

cb6a4d0

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 29, 2026 16:26

Copilot started reviewing on behalf of peter-leonov-ch April 29, 2026 16:26 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Comment thread tests/e2e/skills/package.json

Comment thread tests/e2e/skills/.gitignore

Comment thread .github/workflows/e2e-skills.yml

Comment thread .github/workflows/e2e-skills.yml

Comment thread tests/e2e/skills/package.json

peter-leonov-ch added 2 commits April 29, 2026 18:31

fix overlapping directories

3457c67

fix where to look for

f436450

github-advanced-security AI found potential problems Apr 29, 2026

View reviewed changes

Comment thread .github/workflows/e2e-skills.yml Dismissed

Comment thread .github/workflows/e2e-skills.yml Dismissed

peter-leonov-ch requested a review from Copilot April 29, 2026 16:34

Copilot started reviewing on behalf of peter-leonov-ch April 29, 2026 16:34 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

fix

4d69387

peter-leonov-ch merged commit 2d7ef25 into main Apr 29, 2026
60 checks passed

peter-leonov-ch deleted the package_skills branch April 29, 2026 16:43

This was referenced May 9, 2026

Document 1.18.4 and 1.18.5 in CHANGELOG.md #713

Merged

docs(AGENTS.md): refresh based on last 4 weeks of PRs #714

Merged

Conversation

peter-leonov-ch commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What's in the tarball

Uh oh!

Uh oh!

codecov Bot commented Apr 29, 2026

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

peter-leonov-ch commented Apr 29, 2026 •

edited

Loading