Replace copilot-setup-steps.yml with a .claude/skills setup skill#705
Conversation
Agent-Logs-Url: https://github.com/ClickHouse/clickhouse-js/sessions/73e8cc03-699d-413c-964c-2bc8279be23a Co-authored-by: peter-leonov-ch <209667683+peter-leonov-ch@users.noreply.github.com>
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR removes the GitHub Actions-based “Copilot Setup Steps” workflow (which eagerly installed dependencies, built packages, and booted ClickHouse) and replaces it with a repo-local .claude/skills/setup.md document intended to be consulted on-demand when setup is actually needed.
Changes:
- Deleted
.github/workflows/copilot-setup-steps.ymlto avoid pre-running heavyweight setup on every agent session. - Added
.claude/skills/setup.mddocumenting how to install deps, build workspaces, and optionally start ClickHouse via Docker Compose for integration tests/examples.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/workflows/copilot-setup-steps.yml |
Removes the pre-start workflow that installed/builds/booted services, reducing default agent startup cost. |
.claude/skills/setup.md |
Adds an on-demand setup guide for installing deps, building workspace packages, and running ClickHouse via Docker Compose. |
💡 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>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
@copilot convert the plain md file into a spec conformant skill with yaml description and stuff |
Agent-Logs-Url: https://github.com/ClickHouse/clickhouse-js/sessions/26d876f3-7295-4b49-82c9-a6e0af8fa15b Co-authored-by: peter-leonov-ch <209667683+peter-leonov-ch@users.noreply.github.com>
`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>
Summary
Removes the
.github/workflows/copilot-setup-steps.ymlworkflow (which slowed agent startup by pre-installing deps, building, and booting ClickHouse) and replaces it with a repo-local spec-conformant skill at.claude/skills/setup/SKILL.mdthat the agent can consult on demand when it actually needs to run tests, lints, or type checks..claude/skills/setup/SKILL.md— spec-conformant skill with YAML frontmatter (name,description), matching the format used byskills/clickhouse-js-node-troubleshooting/SKILL.md. Documents:>=20,.nvmrc= 22, CI tests Node 20/22/24).examples/nodeandexamples/webpackages).npm run buildso workspace packages can resolve each other.docker compose up -dfor integration tests, with a note that unit tests don't need a server, plus how to overrideCLICKHOUSE_VERSION.npm run test:*,lint,typecheck, and example scripts..github/workflows/copilot-setup-steps.ymlso the setup job no longer runs before every agent session.Checklist