@sven1103/opencode-worktree-workflow 0.1.0 → 0.3.0

package/README.md

@@ -4,7 +4,17 @@
 
 ## Install in an OpenCode project
 
-Add the plugin package to your project config:
+Add the package as a project dependency, following the official docs style:
+
+```json
+{
+  "dependencies": {
+    "@sven1103/opencode-worktree-workflow": "^0.2.0"
+  }
+}
+```
+
+Then reference the installed package from your OpenCode config:
 
 ```json
 {
@@ -13,7 +23,56 @@ Add the plugin package to your project config:
 }
 ```
 
-OpenCode installs npm plugins with Bun when it starts.
+Keeping the npm dependency in `package.json` makes the installation more durable even if shared `opencode.json` bundles overwrite plugin entries.
+
+If you do not already install dependencies in your project, you can add the package directly with npm:
+
+```sh
+npm install @sven1103/opencode-worktree-workflow
+```
+
+## Install slash commands
+
+OpenCode loads custom commands from either `.opencode/commands/` (project) or `~/.config/opencode/commands/` (global).
+
+This repo publishes `wt-new.md` and `wt-clean.md` as GitHub Release assets so you can install them without browsing the repository.
+
+Project install (latest release):
+
+```sh
+mkdir -p .opencode/commands
+curl -fsSL "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/latest/download/wt-new.md"  -o ".opencode/commands/wt-new.md"
+curl -fsSL "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/latest/download/wt-clean.md" -o ".opencode/commands/wt-clean.md"
+```
+
+```sh
+mkdir -p .opencode/commands
+wget -qO ".opencode/commands/wt-new.md"  "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/latest/download/wt-new.md"
+wget -qO ".opencode/commands/wt-clean.md" "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/latest/download/wt-clean.md"
+```
+
+Global install (latest release):
+
+```sh
+mkdir -p ~/.config/opencode/commands
+curl -fsSL "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/latest/download/wt-new.md"  -o "$HOME/.config/opencode/commands/wt-new.md"
+curl -fsSL "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/latest/download/wt-clean.md" -o "$HOME/.config/opencode/commands/wt-clean.md"
+```
+
+```sh
+mkdir -p ~/.config/opencode/commands
+wget -qO "$HOME/.config/opencode/commands/wt-new.md"  "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/latest/download/wt-new.md"
+wget -qO "$HOME/.config/opencode/commands/wt-clean.md" "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/latest/download/wt-clean.md"
+```
+
+Pinned to a specific release tag:
+
+```sh
+VERSION=v0.1.0
+mkdir -p .opencode/commands
+curl -fsSL "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/download/${VERSION}/wt-new.md"  -o ".opencode/commands/wt-new.md"
+curl -fsSL "https://github.com/sven1103-agent/opencode-worktree-plugin/releases/download/${VERSION}/wt-clean.md" -o ".opencode/commands/wt-clean.md"
+```
 
 ## What the plugin provides
 
@@ -31,7 +90,7 @@ You can override the defaults in `opencode.json`, `opencode.jsonc`, or `.opencod
   "worktreeWorkflow": {
     "branchPrefix": "wt/",
     "remote": "origin",
-    "worktreeRoot": "../.worktrees/$REPO",
+    "worktreeRoot": ".worktrees/$REPO",
     "cleanupMode": "preview",
     "protectedBranches": ["release"]
   }
@@ -54,9 +113,11 @@ Typical release flow:
 
 1. Publish the package once manually to create it on npm.
 2. Configure the package's trusted publisher on npm for `.github/workflows/publish.yml`.
-3. Tag a release like `v0.1.0` and push the tag.
+3. Run the `Prepare Release` workflow from `main` with a version like `0.2.0`.
+
+The release workflow creates a `release/v<version>` branch from `main`, updates `package.json` and `package-lock.json`, commits the version bump there, creates a matching `v<version>` tag, and pushes the branch and tag.
 
-The GitHub Actions workflow then runs `npm publish` using OIDC, without storing an `NPM_TOKEN` secret.
+The release workflow then explicitly starts the publish workflow for that tag, which verifies the tag matches `package.json` before running `npm publish` using OIDC, without storing an `NPM_TOKEN` secret. Merge the release branch back to `main` afterward if you want the version bump recorded on the default branch.
 
 ## Local development
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sven1103/opencode-worktree-workflow",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "OpenCode plugin for creating and cleaning up git worktrees.",
   "type": "module",
   "main": "./src/index.js",

package/src/index.js

@@ -7,7 +7,7 @@ import { tool } from "@opencode-ai/plugin";
 const DEFAULTS = {
   branchPrefix: "wt/",
   remote: "origin",
-  worktreeRoot: "../.worktrees/$REPO",
+  worktreeRoot: ".worktrees/$REPO",
   cleanupMode: "preview",
   protectedBranches: [],
 };