diff --git a/.github/workflows/release-dsh-plugin.yml b/.github/workflows/release-dsh-plugin.yml index 3e5ca41..c7dacdb 100644 --- a/.github/workflows/release-dsh-plugin.yml +++ b/.github/workflows/release-dsh-plugin.yml @@ -103,39 +103,3 @@ jobs: fi pnpm publish --access public --no-git-checks echo "Published ${PACKAGE_NAME}@${{ needs.resolve.outputs.version }}" - - - name: Verify published version and README - working-directory: ${{ env.PACKAGE_DIR }} - run: | - node --input-type=module <<'NODE' - import assert from "node:assert/strict"; - import { readFile } from "node:fs/promises"; - import { setTimeout } from "node:timers/promises"; - - const { name, version } = JSON.parse(await readFile("package.json", "utf8")); - const readme = await readFile("README.md", "utf8"); - const url = `https://registry.npmjs.org/${encodeURIComponent(name)}`; - - for (let attempt = 1; attempt <= 6; attempt++) { - try { - const response = await fetch(url, { - headers: { "Cache-Control": "no-cache" }, - signal: AbortSignal.timeout(10_000), - }); - assert.ok(response.ok, `npm registry returned HTTP ${response.status}`); - const metadata = await response.json(); - assert.equal(metadata.versions?.[version]?.version, version, "Published version is missing"); - assert.equal(metadata["dist-tags"]?.latest, version, "npm latest does not match the release"); - assert.ok(metadata.readme === readme, "npm README does not match the release"); - console.log(`Verified ${name}@${version}: latest tag and README match`); - break; - } catch (error) { - if (attempt === 6) { - console.error("Publication succeeded, but registry verification failed. Check npm before retrying the workflow."); - throw error; - } - console.log(`Registry verification attempt ${attempt} failed; retrying in 10 seconds`); - await setTimeout(10_000); - } - } - NODE diff --git a/README.md b/README.md index 83108d0..5cf4e81 100644 --- a/README.md +++ b/README.md @@ -150,11 +150,11 @@ BrowserSkill ships a first-class dsh plugin on npm as It gives the agent native `browser_*` tools and a live view of its browser sessions in the Web UI. The plugin runs `bsk` on the agent's behalf. -Install the `bsk` CLI and connect the browser extension first. Then add the latest -published plugin to a dsh profile and start it (replace `web` with your profile name): +Install the `bsk` CLI and connect the browser extension first. Then add the plugin +to a dsh profile and start it (replace `web` with your profile name): ```sh -dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin@latest +dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin dsh --profile web ``` diff --git a/README.zh-CN.md b/README.zh-CN.md index f0810da..b0c8582 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -127,10 +127,10 @@ bsk install-skill 在用 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)（`dsh`）？BrowserSkill 提供了官方 dsh 插件，已发布到 npm：[`@wxg-prc-cpg/browser-skill-dsh-plugin`](https://www.npmjs.com/package/@wxg-prc-cpg/browser-skill-dsh-plugin)。它为 Agent 提供原生 `browser_*` 工具，由插件代为调用 `bsk`，并在 Web UI 中实时展示浏览器会话。 -先安装 `bsk` CLI 并连接浏览器扩展，再将最新发布的插件装进 dsh profile 并启动（将 `web` 替换为你的 profile 名称）： +先安装 `bsk` CLI 并连接浏览器扩展，再将插件装进 dsh profile 并启动（将 `web` 替换为你的 profile 名称）： ```sh -dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin@latest +dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin dsh --profile web ``` diff --git a/packages/dsh-plugin-browserskill/README.md b/packages/dsh-plugin-browserskill/README.md index 9406fb6..388a712 100644 --- a/packages/dsh-plugin-browserskill/README.md +++ b/packages/dsh-plugin-browserskill/README.md @@ -17,10 +17,10 @@ Before installing the plugin: Follow the [BrowserSkill setup guide](https://github.com/Tencent/BrowserSkill#quick-start). - Make sure `bsk` is on the `PATH` used to start dsh, or set `bskPath` in the plugin configuration. -Install the latest published version into the `web` profile, then start it: +Install the plugin into the `web` profile, then start it: ```sh -dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin@latest +dsh plugin --profile web add @wxg-prc-cpg/browser-skill-dsh-plugin dsh --profile web ``` @@ -37,8 +37,8 @@ By default, the browser tools become available when the skill is invoked. ## Updating -`@latest` selects npm's latest published version when you install. Installed plugins -do not update automatically. To upgrade this plugin in your profile: +Installed plugins do not update automatically. To upgrade this plugin to npm's +`latest` version, including versions outside the profile's saved dependency range: ```sh dsh plugin --profile web update @wxg-prc-cpg/browser-skill-dsh-plugin --latest @@ -79,7 +79,30 @@ can never touch a session owned by another program. ## Configuration -All plugin configuration fields are optional: +After installing the plugin, edit your profile's `cordis.patch.yml`. For the `web` +profile, the default location is `~/.dsh/profiles/web/cordis.patch.yml`. If you set +`DSH_HOME`, use `$DSH_HOME/profiles/web/cordis.patch.yml` instead. Replace `web` with +your profile name as needed. + +Add the following entry to the file's patch list, or edit the existing +`id: browserskill` entry. This overrides the plugin registered by the installed bundle: + +```yaml +- id: browserskill + config: + bskPath: bsk + defaultTimeoutMs: 120000 + maxSessions: 5 + observationEnabled: true + thumbnailIntervalMs: 1500 + idleIntervalMs: 8000 + lazyTools: true +``` + +Change `bskPath` to the full path of your CLI binary if it is not on dsh's `PATH`. +A patch replaces the entry's entire `config` object, so keep all overrides you need +together in that object. Restart the profile to apply the configuration. +All fields are optional; omitted fields use the defaults below: | Option | Default | Purpose | | --- | --- | --- | @@ -91,6 +114,11 @@ All plugin configuration fields are optional: | `idleIntervalMs` | `8000` | Screenshot interval for idle sessions and the recent-activity window, in milliseconds. | | `lazyTools` | `true` | Reveal the browser tools when the skill is invoked. Set `false` to register them at startup. | +With `lazyTools: true`, only the skill's catalog entry is initially advertised to +the model. The six `browser_*` tool schemas are added to the system prompt after +the `browser-skill` skill is successfully invoked, either by the model or through +`/browser-skill`. Set `lazyTools: false` to make the tools available immediately. + ## Live browser view The dsh Web UI shows the plugin's browser sessions in a floating panel. If your @@ -127,22 +155,30 @@ The [Release dsh plugin workflow](https://github.com/Tencent/BrowserSkill/blob/m publishes the package and this README to npm. Pushing a `dsh-plugin-vX.Y.Z` tag triggers it; ordinary commits to `main` do not. -1. Update this README and prepare a new stable version using the repository's - [release script](https://github.com/Tencent/BrowserSkill/blob/main/scripts/release.mjs). - CLI, extension, and DSH plugin versions are coordinated by that script. -2. Commit the release changes before tagging. From the repository root, derive the - tag from the plugin's `package.json` so the versions match: +1. Commit this README and any other changes intended for the release. +2. From the repository root, run the + [release script](https://github.com/Tencent/BrowserSkill/blob/main/scripts/release.mjs) + with a new stable version, replacing `` below. The script updates the + CLI, extension, and DSH plugin versions, commits the version changes, and creates + their release tags: ```sh - version=$(node -p "require('./packages/dsh-plugin-browserskill/package.json').version") - git tag "dsh-plugin-v${version}" - git push origin "dsh-plugin-v${version}" + node scripts/release.mjs ``` - If the release script already created the tag, run the version assignment and - push command, skipping `git tag`. -3. The workflow checks the version, runs typechecks and tests, builds the package, - publishes it, and verifies npm's `latest` version and README. +3. Push the version commit to the release branch, then push the DSH plugin tag + created by the script, using the same ``: + + ```sh + git push origin HEAD + git push origin dsh-plugin-v + ``` + + This publishes the DSH plugin. Push the CLI and extension tags separately when + those components are ready for release. + +The workflow checks the version, runs typechecks and tests, builds the package, +and publishes it to npm. You can also run the workflow manually from GitHub Actions on the intended release ref. Both triggers require an unpublished version and the `NPM_TOKEN` secret in the diff --git a/packages/dsh-plugin-browserskill/docs/development.md b/packages/dsh-plugin-browserskill/docs/development.md index 75d637f..3d0fa2a 100644 --- a/packages/dsh-plugin-browserskill/docs/development.md +++ b/packages/dsh-plugin-browserskill/docs/development.md @@ -25,6 +25,12 @@ missing supported browser tools before embedding the Markdown. Registration and catalog snapshot are pure in-memory reads (no disk/process/daemon); compositions without the skill seam degrade silently. +With `lazyTools: true`, the six tool schemas stay out of the system prompt until +the skill is successfully invoked. Registration happens once and lasts until the +plugin is unloaded. Repeated invocations do not register duplicate tools. Entering +a resumed conversation whose history contains a successful skill invocation also +registers the tools. Setting `lazyTools: false` registers them at plugin startup. + ## Observation subscriptions and routes - **Screenshot demand**: the client requests periodic screenshots while an observation view is