Releases: ubgo/docsync
Release list
Go module: docsync 0.1.3 (no downloads)
The docsync library module, 0.1.3, part of the 0.1.5 release. To install the tool, see ds/v0.1.5.
go get github.com/ubgo/docsync@v0.1.3See CHANGELOG.md.
Go module: docsync 0.1.2 (no downloads)
The docsync library, 0.1.2: policy.require_doc and the unmarked report now count a file by its extension, whichever tier read it, so they cover languages read by a syntax tier. Licensed Apache-2.0. To install the tool, see ds/v0.1.4.
go get github.com/ubgo/docsync@v0.1.2See CHANGELOG.md.
Go module: docsync 0.1.1 (no downloads)
The docsync library, 0.1.1: config.RunConfig gains Shell (the [run] shell key, default config.DefaultRunShell, "sh"). Nothing else changed. To install the tool, see ds/v0.1.3.
go get github.com/ubgo/docsync@v0.1.1See CHANGELOG.md.
Go module: ext/treesitter 0.1.2 (no downloads)
The docsync ext/treesitter module, 0.1.2, part of the 0.1.5 release. To install the tool, see ds/v0.1.5.
go get github.com/ubgo/docsync/ext/treesitter@v0.1.2See CHANGELOG.md.
Go module: ext/treesitter 0.1.1 (no downloads)
Go module: ext/structured 0.1.1 (no downloads)
The docsync ext/structured module, 0.1.1, part of the 0.1.5 release. To install the tool, see ds/v0.1.5.
go get github.com/ubgo/docsync/ext/structured@v0.1.1See CHANGELOG.md.
Go module: ext/records/sqlite 0.1.1 (no downloads)
The docsync ext/records/sqlite module, 0.1.1, part of the 0.1.5 release. To install the tool, see ds/v0.1.5.
go get github.com/ubgo/docsync/ext/records/sqlite@v0.1.1See CHANGELOG.md.
ds 0.1.5 — the CLI (downloads)
ds 0.1.5: 81 fixes from a sweep that ran every documented behaviour against the binary, and a seventh secret-resolver plugin.
Read before upgrading
ds check --resolvenow also needs[resolve] enabled = truein.ds/config.toml, as--runneeds[run] enabled. Without it,dssays so on stderr and contacts nothing.- Config keys that were accepted and did nothing are refused when the config loads:
notify.github_issues,[sources.*],[workspace.id],[workspace.env]. - The text summary of
ds checksaysokinstead ofnone, and prints the diff under each finding. - Repo-mode copies keep working;
ds refreshrewrites their links relative to the page when you next run it.
What changed, briefly
- Checking: the diff under a finding is taken from the body the citation was acked at, never the wrong old version; a signature change checked without a scan no longer passes
stability=api; a changed constant is avaluechange; output order no longer depends on random id suffixes. ds def: never writes a directive into a.properties/INI/.envvalue; finds every name a scan records (Holder.Member, Python constants, TypeScript object paths, HCL and TOML tables, shell functions);path:A-Bbinds that range.- Directives: more file types, multi-line directive comments, link-form values with spaces (
[text](<ds:…>)) and quoted values,span=in YAML/TOML/HCL,type=and id validation. - Commands:
render --atuses that commit throughout; rendered links are relative to the page;context --since <commit>works;ds lspuses the editor's workspace root;github comment --dry-runneeds no token. - Secrets, URLs, runs: 1Password addresses resolve; Vault addresses resolve; new
ds-resolve-envplugin;local=trueis checked where its file exists;ds:runhonourstimeout=andexpect=; a link that gets no answer isunverifiable, never cached as dead. - Cross-repo and agents: another repository's citation says where to ack it;
ds whylists citers in other repositories; a git-hosted index is cloned on first use; MCP acks need a delegate listed in[owners];ds init --agentsregistersds mcpwith Cursor, VS Code and Gemini configs where present. - Integrations: the Docusaurus plugin builds on Docusaurus 3.10; the Hugo status partial lists only the current page; the GitHub action commits acks made through its label.
The full list, with the fixed bug numbers, is in the changelog. The user guide is now executable: every example in it runs against the binary in the project's gate.
Install
macOS (Apple silicon) and Linux (amd64, arm64):
curl -fsSL https://raw.githubusercontent.com/ubgo/docsync/main/install.sh | shWindows (amd64, ARM64), in PowerShell:
irm https://raw.githubusercontent.com/ubgo/docsync/main/install.ps1 | iexWith Go 1.26+ and a C compiler:
go install github.com/ubgo/docsync/cli/cmd/ds@v0.1.5Every archive holds ds and the six secret-resolver plugins (aws, env, gcp, github, onepassword, vault), with a checksums.txt.
ds 0.1.4 — the CLI (downloads)
ds 0.1.4: three fixes for changes that went unnoticed, the user guide, and a move to the Apache License 2.0.
What changed
- Fixed: Go string text is now part of the hash. Changing
errors.New("account locked")to"account suspended", a URL or a query inside a Go function never flagged the sentences citing it. - Fixed:
policy.require_docandds report's unmarked view now cover Go, TypeScript, TSX, JavaScript, Python and SQL. They used to skip every file read by a tree-sitter grammar. - Fixed:
ds github commentleft each block diff's code fence open, so the rest of the comment rendered as code. - The extraction cache is keyed on the
dsbuild, so an upgrade re-reads each file once. - License: Apache-2.0 from this release on.
- Docs: the user guide is at docs/guide.
Upgrading
Go blocks whose code contains a "…" string get a new hash, so their citations report once after the upgrade. The changelog has a prompt a coding agent can follow to re-ack only the citations whose code did not change.
Install
macOS (Apple silicon) and Linux (amd64, arm64):
curl -fsSL https://raw.githubusercontent.com/ubgo/docsync/main/install.sh | shWindows (amd64, ARM64), in PowerShell:
irm https://raw.githubusercontent.com/ubgo/docsync/main/install.ps1 | iexWith Go 1.26+ and a C compiler:
go install github.com/ubgo/docsync/cli/cmd/ds@v0.1.4Every archive holds ds and the five secret-resolver plugins, with a checksums.txt.
ds 0.1.3 — the CLI (downloads)
ds 0.1.3: a configurable shell for ds:run, a Windows concurrency fix, and the end-to-end matrices now running on Linux and Windows.
What changed
- New:
[run] shellnames the shell thatds:runcommands and the[review]command run under (defaultsh), for machines withoutshor teams whose commands are written for another shell (shell = "pwsh"). - Fixed: when the shell is not on PATH,
ds check --runandds review --aistop with an error naming the shell and the key. Before, every command was recorded as a failed run with no output. - Fixed on Windows: a
ds checkrunning beside ads scancould fail, or make the scan fail, because Windows refuses to replace a file another process has open at that instant. Reads and writes under.ds/now wait that out. - A
ds:run file=script is passed to the shell as an argument of its own.
Every archive holds ds and the five secret-resolver plugins.
Install
macOS (Apple silicon) and Linux (amd64, arm64):
curl -fsSL https://raw.githubusercontent.com/ubgo/docsync/main/install.sh | shWindows (amd64, ARM64), in PowerShell:
irm https://raw.githubusercontent.com/ubgo/docsync/main/install.ps1 | iexWith Go 1.26+ and a C compiler (this is the way on an Intel Mac, for which there is no prebuilt binary):
go install github.com/ubgo/docsync/cli/cmd/ds@v0.1.3Or download the archive for your platform below and check it against checksums.txt. See CHANGELOG.md.