Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows
docs: trim code signing policy and clarify test signing (#4572)
Maximilian Roos46b2f5f6fd1b
diff --git a/docs/public/llms.txt b/docs/public/llms.txtindex cd1214c96..6d479b27d 100644--- a/docs/public/llms.txt+++ b/docs/public/llms.txt@@ -28,4 +28,4 @@ copy-on-write build caches.- [Tips & Patterns](https://worktrunk.dev/tips-patterns.md): Practical recipes for Worktrunk workflows: repo layout, aliases and hooks, per-worktree dev servers and databases, agent handoffs, and branch status.- [Shell integration](https://worktrunk.dev/shell-integration.md): How Worktrunk's shell wrapper changes the parent shell's directory, which files each shell gets, and how to debug integration that isn't working.- [FAQ](https://worktrunk.dev/faq.md): Common questions about Worktrunk: comparison to git worktree and branch switching, bare repos, TUI support, and more.-- [Code Signing Policy](https://worktrunk.dev/code-signing.md): How Worktrunk's Windows release binaries are code-signed: certificate provenance, the build and signing pipeline, project roles, and per-release approval.+- [Code Signing Policy](https://worktrunk.dev/code-signing.md): Windows code signing, release approval, and privacy.diff --git a/docs/src/content/docs/code-signing.md b/docs/src/content/docs/code-signing.mdindex 08f0ff703..f6bd10138 100644--- a/docs/src/content/docs/code-signing.md+++ b/docs/src/content/docs/code-signing.md@@ -1,56 +1,47 @@---title: "Code Signing Policy"-description: "How Worktrunk's Windows release binaries are code-signed: certificate provenance, the build and signing pipeline, project roles, and per-release approval."+description: "Windows code signing, release approval, and privacy."sidebar:order: 27----This page is Worktrunk's **code signing policy**. It describes what gets signed, which certificate is used, how the signing pipeline works, and who authorizes each release. It exists both to document the process for users and to satisfy the transparency requirements of the [SignPath Foundation](https://signpath.org/) open-source code signing program.+Worktrunk's SignPath Foundation application is under review. The Windows signing pipeline currently uses a self-signed test certificate and allows unsigned releases if signing fails.## Why signing matters-Worktrunk's Windows binaries (`wt.exe` and `git-wt.exe`) are small, native executables. Microsoft Defender's machine-learning heuristics routinely flag unsigned native executables of this shape as generic threats (for example `Trojan:Win32/Wacatac.B!ml`) — a false positive driven by the *absence of a trusted signature*, not by anything in the code. A valid [Authenticode](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/authenticode) signature gives Defender's cloud something signed to trust, which is what stops that class of false positive. Signing the Windows artifacts is the durable fix.--The macOS and Linux release artifacts, the crates.io source distribution, and `cargo install` builds are unaffected by this policy — `cargo install` compiles locally from source and never downloads a pre-built artifact.+[Authenticode](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/authenticode) signatures identify a binary's publisher and verify that it has not changed since signing.## Signing certificate> Free code signing provided by [SignPath.io](https://signpath.io/), certificate by [SignPath Foundation](https://signpath.org/).-The certificate's private key is generated and held on SignPath's Hardware Security Module (HSM); no maintainer ever possesses the private key. Signing happens only through SignPath's service, invoked from Worktrunk's release pipeline.+SignPath holds the private key in a hardware security module; maintainers do not have access to it.## What is signed-- `wt.exe` and `git-wt.exe` — the Windows binaries shipped in the `x86_64-pc-windows-msvc` release archive on each [GitHub Release](https://github.com/max-sixty/worktrunk/releases) and distributed via [winget](https://github.com/microsoft/winget-pkgs) (`winget install max-sixty.worktrunk`). `git-wt.exe` is the same program built as a git subcommand.--Nothing else is signed under this policy. Signed artifacts contain only code built from this repository; any bundled third-party libraries are used unmodified.+The signing pipeline covers `wt.exe` and `git-wt.exe` in the `x86_64-pc-windows-msvc` archive on [GitHub Releases](https://github.com/max-sixty/worktrunk/releases), also distributed through winget.## Build and signing pipeline-1. Every release is triggered by pushing a version tag to [`max-sixty/worktrunk`](https://github.com/max-sixty/worktrunk). No release is built from any other source.-2. The [`release` workflow](https://github.com/max-sixty/worktrunk/blob/main/.github/workflows/release.yaml) builds the platform binaries with [cargo-dist](https://axodotdev.github.io/cargo-dist/) on GitHub-hosted runners, from the tagged commit only.-3. The Windows binary is submitted to SignPath for signing via the [SignPath GitHub Action](https://github.com/SignPath/github-action-submit-signing-request). The signed binary is returned to the workflow and published in the release archive.-4. The build is reproducible from public source: the workflow, the toolchain pin ([`rust-toolchain.toml`](https://github.com/max-sixty/worktrunk/blob/main/rust-toolchain.toml)), and the release configuration ([`dist-workspace.toml`](https://github.com/max-sixty/worktrunk/blob/main/dist-workspace.toml)) are all tracked in this repository.+The [`release` workflow](https://github.com/max-sixty/worktrunk/blob/main/.github/workflows/release.yaml) builds tagged commits with [cargo-dist](https://axodotdev.github.io/cargo-dist/) on GitHub-hosted runners. It submits the Windows archive to SignPath and publishes the signed archive when signing succeeds.## Project roles-Worktrunk follows SignPath's team model:+[@max-sixty](https://github.com/max-sixty) holds all signing roles:-| Role | Responsibility | Who |-|------|----------------|-----|-| **Author** | Trusted developer who commits and tags releases | [@max-sixty](https://github.com/max-sixty) |-| **Reviewer** | Reviews contributions from outside the trusted set before they can be released | [@max-sixty](https://github.com/max-sixty) |-| **Approver** | Authorizes each signing request for a release | [@max-sixty](https://github.com/max-sixty) |+- **Author**: commits code and tags releases.+- **Reviewer**: reviews external contributions before release.+- **Approver**: authorizes signing requests.-All maintainers with signing authority use multi-factor authentication on their GitHub and SignPath accounts.+Maintainers with signing authority use multi-factor authentication on GitHub and SignPath.## Release approval-Every signing request requires **manual approval** by an Approver before the certificate is applied — signing is never fully automated. A release is signed only after the Approver has confirmed the artifact was built from the tagged commit in this repository.+Under this policy, each signing request requires manual approval after confirming that the artifact was built from the repository's tagged commit.## Privacy-Worktrunk is a local-first command-line tool. It performs no telemetry, collects no analytics, and transmits no user data. Network access happens only when a command the user ran needs it (for example, fetching CI status for `wt list --full`); the [FAQ](/faq/) and inline documentation describe exactly when. The signed binaries add no data collection of any kind.+Worktrunk collects no telemetry or analytics. It transfers information to other systems only for operations requested or configured by the user.## Reporting a problem-If you believe a signed Worktrunk binary has been tampered with, or you receive an antivirus detection on an official release artifact, please [open an issue](https://github.com/max-sixty/worktrunk/issues). For a suspected Defender false positive, you can also report the file to Microsoft through the [Windows Defender submission portal](https://www.microsoft.com/en-us/wdsi/filesubmission) (as *"I believe this file is safe"*), which corrects the cloud definition for every user.+Report suspected tampering or antivirus detections on official release artifacts by [opening an issue](https://github.com/max-sixty/worktrunk/issues). Suspected Defender false positives can also be submitted to [Microsoft for review](https://www.microsoft.com/en-us/wdsi/filesubmission).diff --git a/plugins/worktrunk/skills/worktrunk/reference/code-signing.md b/plugins/worktrunk/skills/worktrunk/reference/code-signing.mdindex b707521a0..336182760 100644--- a/plugins/worktrunk/skills/worktrunk/reference/code-signing.md+++ b/plugins/worktrunk/skills/worktrunk/reference/code-signing.md@@ -1,52 +1,43 @@# Code Signing Policy-This page is Worktrunk's **code signing policy**. It describes what gets signed, which certificate is used, how the signing pipeline works, and who authorizes each release. It exists both to document the process for users and to satisfy the transparency requirements of the [SignPath Foundation](https://signpath.org/) open-source code signing program.+Worktrunk's SignPath Foundation application is under review. The Windows signing pipeline currently uses a self-signed test certificate and allows unsigned releases if signing fails.## Why signing matters-Worktrunk's Windows binaries (`wt.exe` and `git-wt.exe`) are small, native executables. Microsoft Defender's machine-learning heuristics routinely flag unsigned native executables of this shape as generic threats (for example `Trojan:Win32/Wacatac.B!ml`) — a false positive driven by the *absence of a trusted signature*, not by anything in the code. A valid [Authenticode](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/authenticode) signature gives Defender's cloud something signed to trust, which is what stops that class of false positive. Signing the Windows artifacts is the durable fix.--The macOS and Linux release artifacts, the crates.io source distribution, and `cargo install` builds are unaffected by this policy — `cargo install` compiles locally from source and never downloads a pre-built artifact.+[Authenticode](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/authenticode) signatures identify a binary's publisher and verify that it has not changed since signing.## Signing certificate> Free code signing provided by [SignPath.io](https://signpath.io/), certificate by [SignPath Foundation](https://signpath.org/).-The certificate's private key is generated and held on SignPath's Hardware Security Module (HSM); no maintainer ever possesses the private key. Signing happens only through SignPath's service, invoked from Worktrunk's release pipeline.+SignPath holds the private key in a hardware security module; maintainers do not have access to it.## What is signed-- `wt.exe` and `git-wt.exe` — the Windows binaries shipped in the `x86_64-pc-windows-msvc` release archive on each [GitHub Release](https://github.com/max-sixty/worktrunk/releases) and distributed via [winget](https://github.com/microsoft/winget-pkgs) (`winget install max-sixty.worktrunk`). `git-wt.exe` is the same program built as a git subcommand.--Nothing else is signed under this policy. Signed artifacts contain only code built from this repository; any bundled third-party libraries are used unmodified.+The signing pipeline covers `wt.exe` and `git-wt.exe` in the `x86_64-pc-windows-msvc` archive on [GitHub Releases](https://github.com/max-sixty/worktrunk/releases), also distributed through winget.## Build and signing pipeline-1. Every release is triggered by pushing a version tag to [`max-sixty/worktrunk`](https://github.com/max-sixty/worktrunk). No release is built from any other source.-2. The [`release` workflow](https://github.com/max-sixty/worktrunk/blob/main/.github/workflows/release.yaml) builds the platform binaries with [cargo-dist](https://axodotdev.github.io/cargo-dist/) on GitHub-hosted runners, from the tagged commit only.-3. The Windows binary is submitted to SignPath for signing via the [SignPath GitHub Action](https://github.com/SignPath/github-action-submit-signing-request). The signed binary is returned to the workflow and published in the release archive.-4. The build is reproducible from public source: the workflow, the toolchain pin ([`rust-toolchain.toml`](https://github.com/max-sixty/worktrunk/blob/main/rust-toolchain.toml)), and the release configuration ([`dist-workspace.toml`](https://github.com/max-sixty/worktrunk/blob/main/dist-workspace.toml)) are all tracked in this repository.+The [`release` workflow](https://github.com/max-sixty/worktrunk/blob/main/.github/workflows/release.yaml) builds tagged commits with [cargo-dist](https://axodotdev.github.io/cargo-dist/) on GitHub-hosted runners. It submits the Windows archive to SignPath and publishes the signed archive when signing succeeds.## Project roles-Worktrunk follows SignPath's team model:+[@max-sixty](https://github.com/max-sixty) holds all signing roles:-| Role | Responsibility | Who |-|------|----------------|-----|-| **Author** | Trusted developer who commits and tags releases | [@max-sixty](https://github.com/max-sixty) |-| **Reviewer** | Reviews contributions from outside the trusted set before they can be released | [@max-sixty](https://github.com/max-sixty) |-| **Approver** | Authorizes each signing request for a release | [@max-sixty](https://github.com/max-sixty) |+- **Author**: commits code and tags releases.+- **Reviewer**: reviews external contributions before release.+- **Approver**: authorizes signing requests.-All maintainers with signing authority use multi-factor authentication on their GitHub and SignPath accounts.+Maintainers with signing authority use multi-factor authentication on GitHub and SignPath.## Release approval-Every signing request requires **manual approval** by an Approver before the certificate is applied — signing is never fully automated. A release is signed only after the Approver has confirmed the artifact was built from the tagged commit in this repository.+Under this policy, each signing request requires manual approval after confirming that the artifact was built from the repository's tagged commit.## Privacy-Worktrunk is a local-first command-line tool. It performs no telemetry, collects no analytics, and transmits no user data. Network access happens only when a command the user ran needs it (for example, fetching CI status for `wt list --full`); the [FAQ](https://worktrunk.dev/faq/) and inline documentation describe exactly when. The signed binaries add no data collection of any kind.+Worktrunk collects no telemetry or analytics. It transfers information to other systems only for operations requested or configured by the user.## Reporting a problem-If you believe a signed Worktrunk binary has been tampered with, or you receive an antivirus detection on an official release artifact, please [open an issue](https://github.com/max-sixty/worktrunk/issues). For a suspected Defender false positive, you can also report the file to Microsoft through the [Windows Defender submission portal](https://www.microsoft.com/en-us/wdsi/filesubmission) (as *"I believe this file is safe"*), which corrects the cloud definition for every user.+Report suspected tampering or antivirus detections on official release artifacts by [opening an issue](https://github.com/max-sixty/worktrunk/issues). Suspected Defender false positives can also be submitted to [Microsoft for review](https://www.microsoft.com/en-us/wdsi/filesubmission).diff --git a/skills/worktrunk/reference/code-signing.md b/skills/worktrunk/reference/code-signing.mdindex b707521a0..336182760 100644--- a/skills/worktrunk/reference/code-signing.md+++ b/skills/worktrunk/reference/code-signing.md@@ -1,52 +1,43 @@# Code Signing Policy-This page is Worktrunk's **code signing policy**. It describes what gets signed, which certificate is used, how the signing pipeline works, and who authorizes each release. It exists both to document the process for users and to satisfy the transparency requirements of the [SignPath Foundation](https://signpath.org/) open-source code signing program.+Worktrunk's SignPath Foundation application is under review. The Windows signing pipeline currently uses a self-signed test certificate and allows unsigned releases if signing fails.## Why signing matters-Worktrunk's Windows binaries (`wt.exe` and `git-wt.exe`) are small, native executables. Microsoft Defender's machine-learning heuristics routinely flag unsigned native executables of this shape as generic threats (for example `Trojan:Win32/Wacatac.B!ml`) — a false positive driven by the *absence of a trusted signature*, not by anything in the code. A valid [Authenticode](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/authenticode) signature gives Defender's cloud something signed to trust, which is what stops that class of false positive. Signing the Windows artifacts is the durable fix.--The macOS and Linux release artifacts, the crates.io source distribution, and `cargo install` builds are unaffected by this policy — `cargo install` compiles locally from source and never downloads a pre-built artifact.+[Authenticode](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/authenticode) signatures identify a binary's publisher and verify that it has not changed since signing.## Signing certificate> Free code signing provided by [SignPath.io](https://signpath.io/), certificate by [SignPath Foundation](https://signpath.org/).-The certificate's private key is generated and held on SignPath's Hardware Security Module (HSM); no maintainer ever possesses the private key. Signing happens only through SignPath's service, invoked from Worktrunk's release pipeline.+SignPath holds the private key in a hardware security module; maintainers do not have access to it.## What is signed-- `wt.exe` and `git-wt.exe` — the Windows binaries shipped in the `x86_64-pc-windows-msvc` release archive on each [GitHub Release](https://github.com/max-sixty/worktrunk/releases) and distributed via [winget](https://github.com/microsoft/winget-pkgs) (`winget install max-sixty.worktrunk`). `git-wt.exe` is the same program built as a git subcommand.--Nothing else is signed under this policy. Signed artifacts contain only code built from this repository; any bundled third-party libraries are used unmodified.+The signing pipeline covers `wt.exe` and `git-wt.exe` in the `x86_64-pc-windows-msvc` archive on [GitHub Releases](https://github.com/max-sixty/worktrunk/releases), also distributed through winget.## Build and signing pipeline-1. Every release is triggered by pushing a version tag to [`max-sixty/worktrunk`](https://github.com/max-sixty/worktrunk). No release is built from any other source.-2. The [`release` workflow](https://github.com/max-sixty/worktrunk/blob/main/.github/workflows/release.yaml) builds the platform binaries with [cargo-dist](https://axodotdev.github.io/cargo-dist/) on GitHub-hosted runners, from the tagged commit only.-3. The Windows binary is submitted to SignPath for signing via the [SignPath GitHub Action](https://github.com/SignPath/github-action-submit-signing-request). The signed binary is returned to the workflow and published in the release archive.-4. The build is reproducible from public source: the workflow, the toolchain pin ([`rust-toolchain.toml`](https://github.com/max-sixty/worktrunk/blob/main/rust-toolchain.toml)), and the release configuration ([`dist-workspace.toml`](https://github.com/max-sixty/worktrunk/blob/main/dist-workspace.toml)) are all tracked in this repository.+The [`release` workflow](https://github.com/max-sixty/worktrunk/blob/main/.github/workflows/release.yaml) builds tagged commits with [cargo-dist](https://axodotdev.github.io/cargo-dist/) on GitHub-hosted runners. It submits the Windows archive to SignPath and publishes the signed archive when signing succeeds.## Project roles-Worktrunk follows SignPath's team model:+[@max-sixty](https://github.com/max-sixty) holds all signing roles:-| Role | Responsibility | Who |-|------|----------------|-----|-| **Author** | Trusted developer who commits and tags releases | [@max-sixty](https://github.com/max-sixty) |-| **Reviewer** | Reviews contributions from outside the trusted set before they can be released | [@max-sixty](https://github.com/max-sixty) |-| **Approver** | Authorizes each signing request for a release | [@max-sixty](https://github.com/max-sixty) |+- **Author**: commits code and tags releases.+- **Reviewer**: reviews external contributions before release.+- **Approver**: authorizes signing requests.-All maintainers with signing authority use multi-factor authentication on their GitHub and SignPath accounts.+Maintainers with signing authority use multi-factor authentication on GitHub and SignPath.## Release approval-Every signing request requires **manual approval** by an Approver before the certificate is applied — signing is never fully automated. A release is signed only after the Approver has confirmed the artifact was built from the tagged commit in this repository.+Under this policy, each signing request requires manual approval after confirming that the artifact was built from the repository's tagged commit.## Privacy-Worktrunk is a local-first command-line tool. It performs no telemetry, collects no analytics, and transmits no user data. Network access happens only when a command the user ran needs it (for example, fetching CI status for `wt list --full`); the [FAQ](https://worktrunk.dev/faq/) and inline documentation describe exactly when. The signed binaries add no data collection of any kind.+Worktrunk collects no telemetry or analytics. It transfers information to other systems only for operations requested or configured by the user.## Reporting a problem-If you believe a signed Worktrunk binary has been tampered with, or you receive an antivirus detection on an official release artifact, please [open an issue](https://github.com/max-sixty/worktrunk/issues). For a suspected Defender false positive, you can also report the file to Microsoft through the [Windows Defender submission portal](https://www.microsoft.com/en-us/wdsi/filesubmission) (as *"I believe this file is safe"*), which corrects the cloud definition for every user.+Report suspected tampering or antivirus detections on official release artifacts by [opening an issue](https://github.com/max-sixty/worktrunk/issues). Suspected Defender false positives can also be submitted to [Microsoft for review](https://www.microsoft.com/en-us/wdsi/filesubmission).