Repository navigation
Tags
Tags
Host resolution fixes (#5, #6) + pipeline hardening + spec consolidat… …ion + MIT license (#14) <!-- agent-pmo:f481f8d --> ## TLDR Re-lands the host binary-resolution bug fixes (#5, #6), hardens this repo's own release/CI pipeline to satisfy the Shipwright supply-chain mandate, consolidates the security/platform specs (10→7 files), cor 8000 rects every package's license to MIT-only, and reworks the security/signing wording across specs, README, website, and the compliance skill. ## Details **Bug fixes (#5, #6) — host binary resolution** - `clients/ts/packages/shipwright-core/src/resolve.ts`: added an `AttemptedCandidate` accumulator so a failed resolve preserves every probed path + failure reason instead of discarding them; `noSourceResolved()` now returns the last attempted path with `errorDetails.attempted`. - `clients/ts/packages/shipwright-vscode/src/probe.ts`: `probeBinaryVersionResult()` with typed `ProbeFailureReason`/`ProbeFailure`/`ProbeResult`, `classifyExecError()`, a 10s default timeout, and `retryOnTimeout`. - `clients/ts/packages/shipwright-vscode/src/activate.ts`: `probeCandidates` now returns `{probes, failures}`; `noSourceResolvedMessage()` produces a truthful, candidate-by-candidate error. New `index.ts` exports. **Supply-chain hardening — this repo's own pipeline now passes its own audit** - `.github/workflows/{ci.yml,release.yml,release.reusable.yml,smoke.reusable.yml}`: every `uses:` SHA-pinned; `dtolnay/rust-toolchain@stable` pinned to a commit SHA + explicit `toolchain: stable`. - New `.github/dependabot.yml`; new templates `templates/gh-actions/dependabot.yml` and `templates/gh-actions/lint-supply-chain.yml`; SHA-pinning applied to `templates/{rust-binary,dotnet-tool-sidecar}/release.yml` and the brew/scoop/vsix/release-binary templates. - `schemas/shipwright.schema.json`: new top-level `supplyChain` block (`slsaBuildLevel`, `provenance`, `sbom`, `signedChecksums`, `frozenInstall`, `pinnedActions`, `oidcPublish`, `vulnGate`) plus `githubRelease` integrity fields (`signature`, `signerWorkflow`, `provenance`, `sbom`, `predicateType`), `bundled.checksum`, `asset.requireHashes`. **Spec consolidation (10 → 7 files)** - Deleted `docs/specs/{binary-signing-notarization,compatibility-matrix,repo-survey}.md`; folded surviving content into `acceptance-gates.md`, `binary-version-contract.md`, `vsix-platform-bundling.md`, and the rewritten `supply-chain-security.md` (threat model + shared controls + per-channel plan). All `SWR-*` IDs preserved; references repointed. **License correction — MIT only (NIMBLESITE PTY LTD)** - `MIT OR Apache-2.0` → `MIT` in `Cargo.toml`, every `package.json`, `*.csproj`, and the rust-binary template; the dual-license sentence in 8 READMEs replaced with a single MIT statement. **Wording rework — mandate, not posture; honest signing status** - `source-projects.md`: survey table points at repo URLs (not file paths), reframed as a plain checklist (no "security holes" language). - `README.md` + `website/src/index.njk`: "security posture" → security **mandate**; signing card now states macOS binaries are Developer ID signed + notarized while native Windows signing remains unsolved (Scoop/Homebrew in the interim). - `supply-chain-security.md`: `[SWR-SIGN-WINDOWS]` reworded (unsolved, not forgotten, use Scoop/Homebrew); gaps table → "Outstanding signing work" (macOS solved, rolling out per binary). - Compliance skill (`SKILL.md`, `reference/audit-checklist.md`, `reference/implement-release.md`): added the MIT-license-honesty check `[SWR-REL-LICENSE]` and the macOS-required / Windows-unsolved-not-a-FAIL rule `[SWR-SIGN-WINDOWS]`; "posture" → "required controls". ## How Do The Automated Tests Prove It Works? - `clients/ts/packages/shipwright-core/test/resolve.test.ts`: new cases assert `errorDetails.attempted` lists each probed source with its path + reason when no source resolves (covers #5). - `clients/ts/packages/shipwright-vscode/test/probe.test.ts`: asserts `classifyExecError()` maps ENOENT / timeout / non-zero exit to the correct `ProbeFailureReason`, and that a timeout retries once (covers #6). - `clients/ts/packages/shipwright-vscode/test/activate.test.ts`: asserts `probeCandidates` returns per-candidate `failures` and that `noSourceResolvedMessage()` renders every attempted candidate. - `tests/fixtures.test.mjs`: runs the AJV validator over every fixture — the updated `deslop/basilisk/sharplsp` manifests assert the new `supplyChain` + GitHub Release integrity branches **validate**, and `fixtures/invalid-manifests/bad-supplychain.json` asserts the schema **rejects** the bad supply-chain input. `fixtures/spec-coverage.json` is keyed to `docs/specs/*.md`, so the 10→7 consolidation stays docs↔fixtures in sync. ## Spec/Doc Changes Yes — spec consolidation (net −3 files); all `SWR-*` IDs preserved and references repointed. ## Breaking Changes No. Schema additions are additive (new optional fields); the spec merges preserve every ID and normative rule. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Build the Pages website with pnpm in the release workflow (#17) <!-- agent-pmo:f481f8d --> ## TLDR Builds the GitHub Pages website with pnpm (its actual package manager) so the release's Pages deploy stops failing on a missing `package-lock.json`. ## Details The `Deploy website to GitHub Pages` job ran `npm ci` then `npx eleventy` in `website/`. But `website/` is a standalone pnpm project — it has `pnpm-lock.yaml` (lockfileVersion 9) and **no** `package-lock.json` — so `npm ci` aborted: ``` npm error The `npm ci` command can only install with an existing package-lock.json ``` `website` is also **not** a member of the root `pnpm-workspace.yaml` (`packages: tools/*, clients/ts/packages/*`), so a plain `pnpm install` inside `website/` resolves up to the root workspace and never installs the site's own dependencies (eleventy). Fix: add `pnpm/action-setup@v4` and run `pnpm install --frozen-lockfile --ignore-workspace` + `pnpm exec eleventy` in `website/`. `--ignore-workspace` makes pnpm treat the site as standalone and honour `website/pnpm-lock.yaml`. ## How Do The Automated Tests Prove It Works? - Reproduced locally: `pnpm install --frozen-lockfile` (no `--ignore-workspace`) installs the **root** workspace and leaves `eleventy: command not found`; with `--ignore-workspace` it installs `@11ty/eleventy 3.1.5` and `pnpm exec eleventy` writes 17 files to `website/_site` (index.html, docs/, sitemap.xml, feed.xml, …), exit 0. - This is the only remaining failing job of the v0.5.3 release; the package registries (npm, crates.io, NuGet) already published successfully. The separate `github-pages` environment tag-deployment policy was also added so `v*` tags may deploy. Breaking changes: none — release tooling only.
Drop unused validator dependency and dead website scripts; resync Car… …go.lock to placeholder version (#14) <!-- agent-pmo:f481f8d --> ## TLDR Removes an unused self-referential validator dependency and dead root scripts, and resyncs `Cargo.lock` to the `0.0.0-dev` placeholder so it matches `Cargo.toml`. ## Details - **`tools/validate-manifest/package.json`** — drop the unused `shipwright: file:../..` dependency. The validator only imports `ajv`/`ajv-formats` (see `tools/validate-manifest/index.mjs`), so the self-referential package install was dead weight. `pnpm-lock.yaml` and `tools/validate-manifest/package-lock.json` are regenerated to match. - **`package.json`** — remove the orphaned `website:build` / `website:dev` scripts. The release Pages job builds the site directly (`npx eleventy` in `website/`), so these `pnpm --dir website` shims were unused. - **`Cargo.lock`** — sync the workspace crate versions from `0.2.0` back to `0.0.0-dev` to match the placeholder version in `Cargo.toml`. Real versions are stamped from the git tag at release time; the lockfile had drifted out of sync. ## How Do The Automated Tests Prove It Works? - **`pnpm install --frozen-lockfile` (CI=true) now exits 0.** Before this change it failed with `ERR_PNPM_OUTDATED_LOCKFILE` because the lockfile still listed the removed `shipwright` dependency — i.e. CI was broken at the install step. - **`make lint`** passes: `cargo clippy --release --all-targets --workspace -- -D warnings` is clean, and `node tools/validate-manifest/index.mjs fixtures/manifests` validates all five product manifests (basilisk, dart-mutant, deslop, sharplsp, too-many-cooks) — confirming the validator still works without the dropped dependency. - **`make test`** passes with 100% line + function coverage on every crate (shipwright, shipwright-host, shipwright-manifest, shipwright-zed, shipwright-version-stamp) plus all 7 `tests/fixtures.test.mjs` subtests. - **TS suites** green: shipwright-core (52 tests), shipwright-vscode (11 tests, including the win32-x64 / win32-arm64 bundled-binary backslash-path resolution tests), shipwright-mcp (5 tests). - **`make build`** compiles the release workspace cleanly with the `0.0.0-dev` placeholder. Breaking changes: none.
v0.5.0
8000fix(release): stamp version from git tag before CI and publish
The release workflow published the 0.0.0-dev placeholder verbatim,
causing npm to reject it ("must specify a tag for prerelease") and
crates.io conflicts. Run shipwright-version-stamp with the pushed tag
before make ci so every manifest (Cargo.toml, package.json, *.csproj,
pubspec.yaml) carries the real release version.
chore: prepare release v0.1.0 — consistency fixes (#6) <!-- agent-pmo:f481f8d --> ## TLDR Pre-release sanity pass after PR #5 — fixes every stale `deploy-stamp` / `@shipwright/*` / `DeployToolkit` / `DTK-` / wrong-PackageId reference that would have shipped a broken v0.1.0. ## Details Per [SWR-REL-PRERELEASE-PR](docs/plans/release-pipeline.md), this is the changelog/release-metadata PR that must merge before the `v0.1.0` tag is pushed. No source version bumps — versions in `Cargo.toml`, `package.json`, `*.csproj`, `pubspec.yaml`, and `build.gradle.kts` are unchanged at `0.1.0` so the tag-triggered workflow ships exactly what reviewers see. ### Real bugs fixed - **`tools/shipwright-version-stamp/src/main.rs`** — the CLI introduced itself as `deploy-stamp` in 7 places (module doc, help text, stderr prefix). Anyone running `--help` got a name that doesn't match the binary path, crate name, README, or the spec in [SWR-VERSION-BUILD-STAMPING]. - **`.github/workflows/release.reusable.yml`** — three `if: hashFiles('tools/deploy-stamp/Cargo.toml')` guards plus a `cargo run --manifest-path tools/deploy-stamp/Cargo.toml ...` invocation. That path has never existed in this repo; downstream products consuming this reusable workflow would have skipped the stamp step entirely and shipped unstamped versions. - **`CHANGELOG.md` [0.1.0] package list** — every line was wrong: - `shipwright-cli` (crate doesn't exist; the Rust CLI crate is `shipwright`) - `deploy-stamp` (real crate: `shipwright-version-stamp`) - `@shipwright/core`, `@shipwright/vscode`, `@shipwright/node`, `@shipwright/validate-manifest` (real scope: `@nimblesite`; the MCP package is `shipwright-mcp` not `node`) - `Shipwright.Tool` (not part of the v0.1.0 NuGet release per [release-pipeline.md §5](docs/plans/release-pipeline.md); only `Shipwright` ships) - Repo URLs case-corrected from `nimblesite/Shipwright` to `Nimblesite/Shipwright` - Maven Central removed from the release-target list (Phase 4 still has unchecked TODOs) - Release date set to today (2026-05-20) - **Root `package.json`** — `test:ts-*` scripts filtered for `@shipwright/core`, `@shipwright/vscode`, `@shipwright/node`. No package in the workspace matches that scope, so `pnpm --filter` matched nothing and the scripts silently no-op'd. Filters now point at the real `@nimblesite/shipwright-*` names; renamed `test:ts-node` → `test:ts-mcp` to match the actual package. - **`templates/vscode-extension/src/extension.ts`** — imported `activateShipwright` from `@shipwright/vscode`. A consumer following the template would get an `ERR_MODULE_NOT_FOUND` at activation. Switched to `@nimblesite/shipwright-vscode`. - **`templates/vscode-extension/README.md`** — same scope wrong in the prose. - **`clients/ts/packages/shipwright-mcp/test/version.test.ts`** — `describe("@shipwright/node", ...)` doesn't match the package being tested. Aligned with `@nimblesite/shipwright-mcp`. - **`docs/plans/release-pipeline.md`** — `NPM_TOKEN` description and the `.npmrc` checklist item both said `@shipwright` scope. Fixed to `@nimblesite`. - **`examples/dotnet-tool/Shipwright.Cli.csproj`** — `<PackageId>Shipwright</PackageId>` collided with the published `Shipwright` library nupkg. `dotnet pack` in the examples tree would have produced a same-named, lower-fidelity package — a footgun. Renamed to `Shipwright.Cli.Example` and added `<IsPackable>false</IsPackable>` so the example can't be accidentally pushed to NuGet. - **`scripts/verify-versions.sh`** — `DTK-REL-VERSION-VERIFY` spec prefix is from the pre-rename era. Updated to `SWR-REL-VERSION-VERIFY` (matches the spec id used in `docs/plans/release-pipeline.md §1.3`). - **`tests/fixtures.test.mjs`** — test name `"tracked DTK ids do not use numeric suffixes"` still mentioned the old prefix even though the regex it enforces (`/\bSWR-[A-Z]+-\d+\b/g`) only matches `SWR-`. Renamed to `"tracked SWR ids do not use numeric suffixes"` to remove the contradiction. ### Out of scope (follow-up tickets) These were noticed during the sanity pass but are not consistency bugs — they're real implementation gaps documented in [release-pipeline.md §13](docs/plans/release-pipeline.md): - `release.yml` has no crates.io, pub.dev, Maven, or GitHub-Release-binary jobs yet (release-pipeline.md Phase 2/3/4 unchecked). - Source-controlled versions are not yet on the `0.0.0-dev` placeholder mandated by [SWR-VERSION-BUILD-STAMPING] (release-pipeline.md §1.1). The release pipeline currently relies on source already carrying `0.1.0`, which works for v0.1.0 but will break the policy from v0.1.1 onward. ## How Do The Automated Tests Prove It Works? `make ci` passes end-to-end on this branch: - Compiled `./target/release/shipwright-version-stamp --help` and confirmed the help banner now begins with `shipwright-version-stamp — stamp a release tag into every language's version field` (was `deploy-stamp — ...`). - Renamed test `tracked SWR ids do not use numeric suffixes` passes — the regex `/\bSWR-[A-Z]+-\d+\b/g` finds zero matches in `docs/specs/`, `docs/plans/`, and `fixtures/spec-coverage.json`. - `manifest schema accepts valid fixtures`, `all invalid manifests fail schema validation`, `plain and JSON version fixtures match the contract`, and `each spec file has fixture coverage or a tracked ticket id` all green — proving the CHANGELOG, csproj `<IsPackable>`, scope renames, and template TS import did not regress validation. - Coverage gate enforces 100.0% lines/functions on every crate (`shipwright-manifest`, `shipwright-host`, `shipwright`, `shipwright-zed`, `shipwright-version-stamp`) and workspace — confirms the version-stamp string edits did not knock out a branch. - `cargo build --release --workspace` builds every crate clean, confirming the workspace still compiles with the renamed help/error strings. - Final repo-wide grep for `deploy[_-]toolkit|deploytoolkit|DeployToolkit|deployment[_-]toolkit|deploy-stamp|@shipwright/|\bDTK-` returns zero results.
Rename Deployment Toolkit to Shipwright (#3) ## TLDR Rename Deployment Toolkit to Shipwright and add the release, package, schema, fixture, and skill scaffolding needed to publish the library across Rust, npm, NuGet, Dart, and editor integrations. ## Details - Added canonical `.agents/skills` project skills and replaced the Claude skill bodies with markdown pointer stubs to the `.agents` `SKILL.md` files. - Renamed workspace crates, schema files, manifests, package names, docs, and templates from Deployment Toolkit to Shipwright, including Rust crates, TypeScript packages, the Dart package, .NET library/test projects, the Kotlin IntelliJ package path, and the manifest validator package. - Added tag-driven release automation that gates on `make ci`, builds/publishes `@nimblesite/shipwright-*` npm packages and the `Shipwright` NuGet package, and updates reusable release/smoke workflow names plus the default manifest path to `shipwright.json`. - Added `templates/gh-actions/publish-vsix-per-platform.yml` for platform-specific VSIX publishing, plus Shipwright-renamed templates for Rust binaries, VS Code, Zed, IntelliJ, and .NET sidecars. - Added `shipwright-version-stamp`, `scripts/coverage_check.py`, `scripts/verify-versions.sh`, per-package coverage thresholds, and public API/integration tests for the renamed crates and tooling. - Updated specs, plans, README, changelog, adoption guidance, manifests, golden fixtures, version-output fixtures, and spec coverage tracking for Shipwright naming and Sharplsp fixtures. - Removed the old `tools/deploy-toolkit` verifier package and replaced Forge fixture/version output coverage with Shipwright-era Sharplsp fixtures. ## How Do The Automated Tests Prove It Works? `make ci` passed locally. - `cargo clippy --release --all-targets --workspace -- -D warnings` passed for the renamed Rust workspace. - Manifest validation passed for `basilisk`, `dart-mutant`, `deslop`, `sharplsp`, and `too-many-cooks`. - `cargo llvm-cov --workspace --all-targets` passed the Rust test suites, including `shipwright` public API tests, `shipwright-host` conformance vectors, `shipwright-manifest` version formatter tests, `shipwright-version-stamp` stamp tests, and `shipwright-zed` LSP tests. - `node --test tests/fixtures.test.mjs` passed all 7 fixture/spec checks, including the reusable release workflow check, version fixture contract checks, spec coverage tracking, and non-numeric `SWR-*` tracked ID validation. - `scripts/coverage_check.py` enforced 100% lines/functions thresholds for every measured package and 100% workspace line coverage. - `cargo build --release --workspace` completed after the test and coverage gate. ## Spec/Doc Changes Updated the Shipwright README, changelog, adoption guide, release pipeline plan, product migration plan, and specs for binary signing/notarization, binary version contract, compatibility matrix, IDE extension deployment, library architecture, VSIX platform bundling, and source projects. ## Breaking Changes Yes. Public names and file paths move from Deployment Toolkit to Shipwright, including crate/package names, the product manifest schema path (`schemas/shipwright.schema.json`), the default product manifest name (`shipwright.json`), generated client package paths, and release workflow/template references.