docs(release): prepare documented release candidate
This commit is contained in:
1 parent
51b9d32007
commit
6629e6ffca
6 files changed
+125
-13
No files matched your search
@@ -50,6 +50,59 @@ Modified managed files are preserved and reported. The installer does not yet
|
||||
remove the npm dependency from the consuming project's `package.json`; remove
|
||||
that dependency separately if desired.
|
||||
|
||||
To update, install the newer checkout or tarball into the consuming project,
|
||||
then rerun the installer. It updates files that still match their recorded
|
||||
hashes and refuses to overwrite a locally modified current file:
|
||||
|
||||
```sh
|
||||
npm install --save-dev /path/to/new-opencode-toolkit.tgz
|
||||
npx opencode-toolkit install .
|
||||
```
|
||||
|
||||
## Verify a package tarball
|
||||
|
||||
For a release candidate, build the package and create a tarball from the checkout:
|
||||
|
||||
```sh
|
||||
npm pack
|
||||
```
|
||||
|
||||
This creates `sargatxet-opencode-toolkit-0.1.0.tgz` for the current provisional
|
||||
package identity and version. In a disposable project, install that tarball
|
||||
rather than linking the checkout:
|
||||
|
||||
```sh
|
||||
npm install --save-dev /path/to/sargatxet-opencode-toolkit-0.1.0.tgz
|
||||
npx opencode-toolkit install .
|
||||
npx opencode-toolkit install .
|
||||
```
|
||||
|
||||
The second install should make no content changes. Check that the expected
|
||||
`toolkit-*` agents and skills are present under `.opencode/`, and that the
|
||||
project config contains the local package plugin path. To verify removal, first
|
||||
edit one installed toolkit file, then run:
|
||||
|
||||
```sh
|
||||
npx opencode-toolkit uninstall .
|
||||
```
|
||||
|
||||
The edited file should be reported as preserved; unmodified managed files and
|
||||
the toolkit plugin entry should be removed. These install/uninstall checks need
|
||||
no model credentials. Plugin activation and tool execution were separately
|
||||
smoke-tested with OpenCode 2.0.24 and a local mock OpenAI-compatible endpoint.
|
||||
Provider-backed agent delegation and skill behavior remain unverified.
|
||||
|
||||
## Safety boundaries
|
||||
|
||||
The installer rejects unmanaged-file collisions, symlinked install paths, and
|
||||
managed files changed since installation. Its ownership manifest is local
|
||||
bookkeeping, not a signed security boundary. Path checks do not protect against
|
||||
another process changing the project tree concurrently; use it on a project
|
||||
directory whose filesystem is trusted. Uninstall removes files incrementally,
|
||||
so resolve any reported I/O error and rerun it rather than deleting the manifest
|
||||
manually. See [`docs/SECURITY-REVIEW.md`](docs/SECURITY-REVIEW.md) for the review
|
||||
scope and limitations.
|
||||
|
||||
After installation, restart or reload OpenCode and select the installed
|
||||
`toolkit-*` skills or subagents as needed. The plugin exposes its namespaced
|
||||
tool through Code Mode. Configure and authenticate your provider normally in
|
||||
@@ -65,21 +118,17 @@ npm run test:coverage
|
||||
npm pack --dry-run
|
||||
```
|
||||
|
||||
The package is tested against OpenCode `2.0.24`. The unit and installer tests
|
||||
are deterministic and do not call an LLM. Plugin activation and tool execution
|
||||
were smoke-tested with a local mock OpenAI-compatible endpoint; provider-backed
|
||||
agent and skill workflows are not yet complete. See [`FIXME.md`](FIXME.md) and
|
||||
[`TODO.md`](TODO.md).
|
||||
The package is tested against OpenCode `2.0.24` and Node.js `20+`. The unit and
|
||||
installer tests are deterministic and do not call an LLM. Plugin activation and
|
||||
tool execution were smoke-tested with a local mock OpenAI-compatible endpoint;
|
||||
provider-backed agent delegation and skill behavior remain unverified.
|
||||
|
||||
## Project documentation
|
||||
## Provenance and security
|
||||
|
||||
- [`AGENTS.md`](AGENTS.md): verified development commands and conventions.
|
||||
- [`docs/IMPLEMENTATION-PLAN.md`](docs/IMPLEMENTATION-PLAN.md): accepted plan,
|
||||
phases, scope, and acceptance criteria.
|
||||
- [`docs/PROVENANCE.md`](docs/PROVENANCE.md): ECC source revision, attribution,
|
||||
adaptations, and content hashes.
|
||||
- [`CHANGELOG.md`](CHANGELOG.md): user-visible changes.
|
||||
- [`TODO.md`](TODO.md) and [`FIXME.md`](FIXME.md): remaining work and known gaps.
|
||||
- [`docs/SECURITY-REVIEW.md`](docs/SECURITY-REVIEW.md): review scope, result,
|
||||
and operational limitations.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in new issue
Block a user