mirror of
https://github.com/iflytek/skillhub.git
synced 2026-11-14 09:01:16 +00:00
docs(release): keep package version guidance publication-neutral
Signed-off-by: XiaoSeS <87064762+XiaoSeS@users.noreply.github.com>
This commit is contained in:
XiaoSeS
parent
18b55582d7
commit
c4e654cf67
3 changed files with 17 additions and 15 deletions
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
All notable CLI behavior changes are documented in this file.
|
||||
|
||||
## 0.2.0 (release candidate)
|
||||
## 0.2.0
|
||||
|
||||
### Added
|
||||
|
||||
|
|
|
|||
|
|
@ -8,13 +8,13 @@ Version `0.2.0` adds source-aware installation status to catalog cards and conve
|
|||
|
||||
Version `0.2.1` defaults to `https://skill.xfyun.cn` when `registryUrl` is omitted. An explicit empty or whitespace-only value still disconnects; existing custom addresses are preserved. CLI defaults and credentials are not inherited.
|
||||
|
||||
Version `0.4.0` is a release candidate using the independent `dsh-v0.4.0` tag. It adds versioned examples and native composer handoff, conversational installation management, and per-location installed versions while retaining the dual-RC compatibility of `0.3.1`. Until npm publication and public-package verification finish, validate this version using its built tarball.
|
||||
Version `0.4.0` uses the independent `dsh-v0.4.0` tag. It adds versioned examples and native composer handoff, conversational installation management, and per-location installed versions while retaining the dual-RC compatibility of `0.3.1`. Check npm for public availability; locally built tarballs can be verified independently as described below.
|
||||
|
||||
## Use an installed skill
|
||||
|
||||
Choose “使用此技能” on an installed card, matching installed-version detail or completed installation result. Catalog entries open a new conversation in the same workspace; conversation entries keep their current session. After installation verification, examples appear above the native composer. Confirm an example or choose a custom task to insert an editable invocation. The original conversation is preserved, and in-conversation use retains its existing text, references and attachments. Complete the task and send it yourself; this action does not submit messages, call a model or install files.
|
||||
|
||||
An active session is required. Shadowed skills, modified files, disabled user invocation or changed context are reported without modifying the draft. Historical receipts are not proof of current installation. This feature is included in the `0.4.0` candidate, not in published `0.3.1`.
|
||||
An active session is required. Shadowed skills, modified files, disabled user invocation or changed context are reported without modifying the draft. Historical receipts are not proof of current installation. This feature is available from `0.4.0`.
|
||||
|
||||
|
||||
## Requirements and validation scope
|
||||
|
|
@ -27,7 +27,7 @@ An active session is required. Shadowed skills, modified files, disabled user in
|
|||
| Build package manager | Bun `1.3.13`, using frozen lockfiles |
|
||||
| UI | Chinese, DSH light/dark themes and narrow layouts |
|
||||
| Verified environments | Both Linux DSH Hosts: strict installation, native probes and browser user/project install, upgrade, removal and cancellation; Windows browser UI and interactions against a real Host |
|
||||
| Validation boundary | Feature candidates have real-model and cross-platform CI evidence; the final `0.4.0` candidate and public package need separate acceptance. These results do not substitute for desktop clients, native Windows/macOS manual interactions or SaaS acceptance |
|
||||
| Validation boundary | The feature implementation has real-model and cross-platform CI evidence; built artifacts and public packages have separate acceptance records. These results do not substitute for desktop clients, native Windows/macOS manual interactions or SaaS acceptance |
|
||||
|
||||
Windows browser acceptance does not establish complete native Windows Host filesystem support. CI results do not replace desktop, model, or target-instance acceptance. See the repository's [compatibility design](../../openspec/changes/add-dsh-native-plugin/compatibility-design.md) and [acceptance criteria](../../openspec/changes/add-dsh-native-plugin/acceptance.md).
|
||||
|
||||
|
|
@ -69,18 +69,19 @@ Published `0.1.0` still requires the original Cordis `4.0.4` baseline and does n
|
|||
|
||||
## Install from npm
|
||||
|
||||
After `0.4.0` is published on npm, use these commands to install it. Check DSH, Node and a complete Cordis combination listed above, stop the target Web Profile Host, then install the exact version. Before publication, use the local candidate instructions below:
|
||||
Query the exact npm version first and install only after confirming availability. Check DSH, Node and a complete Cordis combination listed above, stop the target Web Profile Host, then install the plugin. A verified local tarball can also be installed using the next section:
|
||||
|
||||
```sh
|
||||
npm view @astron-team/skillhub-dsh@0.4.0 version
|
||||
dsh plugin --profile skillhub-test add @astron-team/skillhub-dsh@0.4.0 --ignore-scripts
|
||||
dsh --profile skillhub-test --host 127.0.0.1 --port 0 --no-open
|
||||
```
|
||||
|
||||
Replace `skillhub-test` with the intended Web Profile; initial creation is documented below. When `registryUrl` is omitted, the plugin uses `https://skill.xfyun.cn`. To use a self-hosted instance, change, test and save the source in plugin settings. Explicitly saving an empty address disconnects. Before publication, use a local candidate; failure to fetch an unpublished npm version does not indicate a plugin loading error.
|
||||
Replace `skillhub-test` with the intended Web Profile; initial creation is documented below. When `registryUrl` is omitted, the plugin uses `https://skill.xfyun.cn`. To use a self-hosted instance, change, test and save the source in plugin settings. Explicitly saving an empty address disconnects. Diagnose npm query/download failures separately from plugin loading errors.
|
||||
|
||||
## Upgrade from an older version
|
||||
|
||||
`0.4.0` uses inventory schema v2 with per-location versions. The installation core remains bundled, so a separate CLI is unnecessary. If the same user also manages these skills through SkillHub CLI, upgrade every such CLI to `0.2.0` before upgrading the plugin and stop scheduled/background writes from old clients. After publication, run `npm install -g @astron-team/skillhub@0.2.0`, verify `skillhub version`, then install the exact plugin version above.
|
||||
`0.4.0` uses inventory schema v2 with per-location versions. The installation core remains bundled, so a separate CLI is unnecessary. If the same user also manages these skills through SkillHub CLI, upgrade every such CLI to `0.2.0` before upgrading the plugin and stop scheduled/background writes from old clients. Confirm availability with `npm view @astron-team/skillhub@0.2.0 version`, then run `npm install -g @astron-team/skillhub@0.2.0`, verify `skillhub version`, then install the exact plugin version above.
|
||||
|
||||
Reading v1 inventory does not migrate it. Before the first v2 write, a byte-verified `inventory.v1.<sha256>.backup.json` is retained beside the inventory. User and project copies may retain different versions. Old CLI/v2 inventory mixed writes are unsupported. Once locations have changed independently, restoring the old inventory or downgrading the plugin alone is not a rollback: skill files, installation metadata and operation records must also be reconciled.
|
||||
|
||||
|
|
@ -183,7 +184,7 @@ dsh plugin --profile skillhub-test remove @astron-team/skillhub-dsh
|
|||
|
||||
## Server synchronization and independent release
|
||||
|
||||
The plugin Host calls anonymous Registry HTTP APIs; local file transactions stay on the Host. SaaS does not need a new API that controls user filesystems. Define and verify contracts in open source first, then synchronize missing routes, fields, anonymous policy and tests to SaaS. Public npm `0.2.0` has verified catalog, search, documentation, version selection and fixed-version project installation against `https://skill.xfyun.cn`, including files/fingerprint, inventory and DSH discovery. This candidate and its public package require separate acceptance. Non-SemVer versions with no reliable ordering, including date-based versions, remain blocked from automatic upgrades; no executable upgrade action is offered. Verified first-time fixed-version installation remains available. Real model execution of SaaS skills is unverified. See the [Registry contract](../../openspec/changes/add-dsh-native-plugin/registry-api-contract.md).
|
||||
The plugin Host calls anonymous Registry HTTP APIs; local file transactions stay on the Host. SaaS does not need a new API that controls user filesystems. Define and verify contracts in open source first, then synchronize missing routes, fields, anonymous policy and tests to SaaS. Public npm `0.2.0` has verified catalog, search, documentation, version selection and fixed-version project installation against `https://skill.xfyun.cn`, including files/fingerprint, inventory and DSH discovery. Each version’s built artifacts and public package require separate acceptance. Non-SemVer versions with no reliable ordering, including date-based versions, remain blocked from automatic upgrades; no executable upgrade action is offered. Verified first-time fixed-version installation remains available. Real model execution of SaaS skills is unverified. See the [Registry contract](../../openspec/changes/add-dsh-native-plugin/registry-api-contract.md).
|
||||
|
||||
The plugin uses independent `dsh-v<version>` tags. `check-dsh-plugin.yml` runs normal clean-install checks on Linux/macOS/Windows × Node 24.2.0/current Node 24, plus an isolated retained-Cordis baseline regression. `release-dsh-plugin.yml` is manual and defaults to candidate-only operation. Publishing requires an approved version, publishable manifest, candidate acceptance and explicit release authorization; configured environment protection rules must also be satisfied. Version updates are explicit commits; npm publication uses the dedicated workflow after release authorization.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,13 +8,13 @@ SkillHub 的 DSH 原生插件。在 DSH 侧栏打开 **技能中心**，匿名
|
|||
|
||||
`0.2.1` 缺省连接 `https://skill.xfyun.cn`；显式空串或仅空白仍表示断开，已有自定义地址保留。插件不继承 CLI 的默认地址或凭证。
|
||||
|
||||
`0.4.0` 为待发布候选，独立标签为 `dsh-v0.4.0`，新增技能案例与原生输入框衔接、对话管理已安装技能及按安装位置独立维护版本。保留 `0.3.1` 的双 RC 兼容范围。npm 发布及公开包验收完成前，使用本版本构建的 tarball 验证。
|
||||
`0.4.0` 使用独立标签 `dsh-v0.4.0`，提供技能案例与原生输入框衔接、对话管理已安装技能及按安装位置独立维护版本。保留 `0.3.1` 的双 RC 兼容范围。公开可用状态以 npm 为准；本地构建的 tarball 可按下文独立验证。
|
||||
|
||||
## 使用已安装技能
|
||||
|
||||
在已安装卡片、已安装版本详情或安装成功结果点击“使用此技能”。技能中心入口在同一工作区新建对话，对话内入口保留当前会话。核验所选安装后，案例显示在原生输入框上方；确认案例或自定义任务后，带入可编辑的技能调用。原会话草稿不会被覆盖，对话内操作保留已有文字、引用和附件。补充任务和材料后自行发送；点击使用不会自动发送、调用模型或安装文件。
|
||||
|
||||
需要当前活动会话。被项目同名技能覆盖、本地文件变更、禁止用户调用或会话/来源变化时会提示原因；历史回执不能代替当前安装状态。此功能包含在 `0.4.0` 候选中，不属于已发布的 `0.3.1` 包。
|
||||
需要当前活动会话。被项目同名技能覆盖、本地文件变更、禁止用户调用或会话/来源变化时会提示原因；历史回执不能代替当前安装状态。此功能自 `0.4.0` 起提供。
|
||||
|
||||
|
||||
## 环境与验证范围
|
||||
|
|
@ -27,7 +27,7 @@ SkillHub 的 DSH 原生插件。在 DSH 侧栏打开 **技能中心**，匿名
|
|||
| 开发包管理器 | Bun `1.3.13`，按锁文件安装 |
|
||||
| 当前 UI | 中文；支持 DSH 深浅主题和窄屏 |
|
||||
| 已验证环境 | Linux 两版 DSH Host 严格安装、原生探针及浏览器用户/项目安装、升级、卸载与取消；Windows 浏览器访问真实 Host 的界面和交互 |
|
||||
| 验证边界 | 功能候选已进行真实模型对话及跨平台 CI；最终 `0.4.0` 候选与公开包须独立验收。真实桌面客户端、原生 Windows/macOS 人工交互和 SaaS 验收不由这些结果替代 |
|
||||
| 验证边界 | 功能实现已进行真实模型对话及跨平台 CI；构建产物与公开包的验收分别记录。真实桌面客户端、原生 Windows/macOS 人工交互和 SaaS 验收不由这些结果替代 |
|
||||
|
||||
Windows 浏览器验证不等于 Windows 原生 Host 的全部文件操作已经验证。CI 的平台矩阵也不替代真实桌面、模型及目标实例验收。完整支持边界见仓库内的 [兼容设计](../../openspec/changes/add-dsh-native-plugin/compatibility-design.md) 和 [验收标准](../../openspec/changes/add-dsh-native-plugin/acceptance.md)。
|
||||
|
||||
|
|
@ -69,18 +69,19 @@ npm pack --ignore-scripts --pack-destination /absolute/path/to/candidate-output
|
|||
|
||||
## 从 npm 安装
|
||||
|
||||
`0.4.0` 在 npm 发布完成后，使用以下命令安装。先确认 DSH、Node 和上表完整 Cordis 组合满足要求，停止目标 Web Profile 的 Host，然后安装精确版本。发布完成前使用下一节的本地候选包：
|
||||
先查询 npm 上的精确版本，确认可用后安装。核对 DSH、Node 和上表完整 Cordis 组合，停止目标 Web Profile 的 Host，再执行插件安装；也可按下一节安装已验证的本地 tarball：
|
||||
|
||||
```sh
|
||||
npm view @astron-team/skillhub-dsh@0.4.0 version
|
||||
dsh plugin --profile skillhub-test add @astron-team/skillhub-dsh@0.4.0 --ignore-scripts
|
||||
dsh --profile skillhub-test --host 127.0.0.1 --port 0 --no-open
|
||||
```
|
||||
|
||||
`skillhub-test` 替换为实际 Web Profile；首次创建方法见下一节。未配置 `registryUrl` 时默认使用 `https://skill.xfyun.cn`。如需自建实例，在插件设置中修改来源并测试、保存；显式保存空地址可断开。发布前请使用本地候选包验收，不要将未发布版本的 npm 安装失败当成插件加载失败。
|
||||
`skillhub-test` 替换为实际 Web Profile；首次创建方法见下一节。未配置 `registryUrl` 时默认使用 `https://skill.xfyun.cn`。如需自建实例，在插件设置中修改来源并测试、保存；显式保存空地址可断开。npm 查询或下载失败与插件加载失败应分别诊断。
|
||||
|
||||
## 从旧版本升级
|
||||
|
||||
`0.4.0` 使用按安装位置记录版本的库存 v2。插件仍内置安装核心，无需为了使用插件单独安装 CLI；如果同一用户还使用 SkillHub CLI 管理这些技能，先将这些 CLI 升级到 `0.2.0`，再升级插件，并停止旧版 CLI 的定时或后台写入。发布完成后使用 `npm install -g @astron-team/skillhub@0.2.0`，确认 `skillhub version`，再执行上面的精确插件版本安装命令。
|
||||
`0.4.0` 使用按安装位置记录版本的库存 v2。插件仍内置安装核心，无需为了使用插件单独安装 CLI；如果同一用户还使用 SkillHub CLI 管理这些技能，先将这些 CLI 升级到 `0.2.0`，再升级插件，并停止旧版 CLI 的定时或后台写入。先用 `npm view @astron-team/skillhub@0.2.0 version` 确认可用，再使用 `npm install -g @astron-team/skillhub@0.2.0`，确认 `skillhub version`，再执行上面的精确插件版本安装命令。
|
||||
|
||||
读取旧库存不迁移；首次写入 v2 前，在库存同目录保存经字节核对的 `inventory.v1.<sha256>.backup.json`。同一技能的用户与项目副本可保留不同版本。旧 CLI 与 v2 库存混写不受支持；已分位置更新后，不能只恢复旧库存文件或降级插件来回退，必须同时核对实际技能文件、安装元数据和操作记录。
|
||||
|
||||
|
|
@ -183,7 +184,7 @@ dsh plugin --profile skillhub-test remove @astron-team/skillhub-dsh
|
|||
|
||||
## 服务端同步与发布
|
||||
|
||||
插件 Host 调用匿名 Registry HTTP API；本地安装事务在 Host 内完成，不需要 SaaS 新增操作用户文件系统的安装接口。开源先定义和验证契约，再将缺失的路径、字段、匿名策略和测试同步到 SaaS。公开 npm `0.2.0` 已对 `https://skill.xfyun.cn` 完成目录、搜索、文档、版本选择和固定版本项目安装及文件/指纹、库存、DSH 发现核验；本版候选和公开包须独立验收。日期格式等无法可靠排序的非 SemVer 版本继续阻断自动升级，不显示可执行升级入口；这不影响已验证的固定版本首次安装。SaaS 技能的真实模型执行尚未验收。详细要求见 [Registry 契约](../../openspec/changes/add-dsh-native-plugin/registry-api-contract.md)。
|
||||
插件 Host 调用匿名 Registry HTTP API；本地安装事务在 Host 内完成，不需要 SaaS 新增操作用户文件系统的安装接口。开源先定义和验证契约，再将缺失的路径、字段、匿名策略和测试同步到 SaaS。公开 npm `0.2.0` 已对 `https://skill.xfyun.cn` 完成目录、搜索、文档、版本选择和固定版本项目安装及文件/指纹、库存、DSH 发现核验；各版本的构建产物与公开包分别验收。日期格式等无法可靠排序的非 SemVer 版本继续阻断自动升级，不显示可执行升级入口；这不影响已验证的固定版本首次安装。SaaS 技能的真实模型执行尚未验收。详细要求见 [Registry 契约](../../openspec/changes/add-dsh-native-plugin/registry-api-contract.md)。
|
||||
|
||||
插件独立使用 `dsh-v<version>` tag，不复用 CLI 或服务镜像发布。`check-dsh-plugin.yml` 配置 Linux/macOS/Windows × Node 24.2.0/当前 Node 24 的普通干净安装检查，并额外保留旧 Cordis 组合的隔离 Host 回归；`release-dsh-plugin.yml` 手动触发，默认只产出候选包。发布需正式版本、可发布 manifest、候选验收及明确发布授权；配置了环境保护规则时还须完成相应审批。版本更新需显式提交，npm 发布需明确授权后运行专用工作流。
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue