Add CI, command reference, and contributing guide#1
Merged
Conversation
CI runs markdownlint, gofmt, go vet, golangci-lint, race-enabled tests with coverage, and cross-compiles linux/amd64 and linux/arm64. Tests use -race because the agent will poll and swap concurrently with OpenVox Server invoking code-id, so races become a live risk as this grows. Writing the command reference surfaced a design gap: OpenVox Server passes only positional arguments, so code-id-command cannot point at /usr/bin/codavox — it would be invoked as 'codavox production' with no subcommand. The binary now dispatches on argv[0] so the package can ship symlinks. A shell wrapper would also work but adds a fork to a path that runs on every catalog compile. Documentation now follows the OpenVox docs style guide: American English, console fences for terminal commands, and OpenVox Server as the component name in prose while literal paths and service names keep their real spelling. CONTRIBUTING records those rules and the two load-bearing design invariants, and flags that GPG/DCO signing is not yet enforced. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The v6 action pins golangci-lint v1.64.8, which cannot parse a version: "2" config and refuses to target a module newer than the Go it was built with: can't load config: the Go language version (go1.24) used to build golangci-lint is lower than the targeted Go version (1.26) v8 is the first action line that installs golangci-lint v2. The version is pinned rather than tracking latest so an unrelated golangci release cannot break CI mid-review. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
miharp
added a commit
that referenced
this pull request
Jul 23, 2026
* Add CI, command reference, and contributing guide CI runs markdownlint, gofmt, go vet, golangci-lint, race-enabled tests with coverage, and cross-compiles linux/amd64 and linux/arm64. Tests use -race because the agent will poll and swap concurrently with OpenVox Server invoking code-id, so races become a live risk as this grows. Writing the command reference surfaced a design gap: OpenVox Server passes only positional arguments, so code-id-command cannot point at /usr/bin/codavox — it would be invoked as 'codavox production' with no subcommand. The binary now dispatches on argv[0] so the package can ship symlinks. A shell wrapper would also work but adds a fork to a path that runs on every catalog compile. Documentation now follows the OpenVox docs style guide: American English, console fences for terminal commands, and OpenVox Server as the component name in prose while literal paths and service names keep their real spelling. CONTRIBUTING records those rules and the two load-bearing design invariants, and flags that GPG/DCO signing is not yet enforced. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * Fix golangci-lint action version The v6 action pins golangci-lint v1.64.8, which cannot parse a version: "2" config and refuses to target a module newer than the Go it was built with: can't load config: the Go language version (go1.24) used to build golangci-lint is lower than the targeted Go version (1.26) v8 is the first action line that installs golangci-lint v2. The version is pinned rather than tracking latest so an unrelated golangci release cannot break CI mid-review. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the CI workflow, documentation for the two working commands, and a contributing guide — plus one behavior change that writing the docs uncovered.
CI
Runs markdownlint,
gofmt,go vet,golangci-lint, race-enabled tests with coverage, and cross-compileslinux/amd64andlinux/arm64.Tests run under
-racedeliberately: the agent will poll and swap versions concurrently with OpenVox Server invokingcode-id, so data races become a live risk as this grows. Better to have the detector on before that code exists than to retrofit it after a heisenbug.arm64is a first-class build target rather than an afterthought, since Parallels VMs and Docker on Apple silicon are both aarch64 — without it nothing installs on the primary dev machine.Behavior change: argv[0] dispatch
Writing the command reference surfaced a gap in the design. OpenVox Server passes only positional arguments to
code-id-command, so the setting cannot point at/usr/bin/codavox— it would be invoked ascodavox production, with no subcommand.The binary now dispatches on
argv[0], so packaging can ship symlinks:A shell wrapper would also work, but it would add a shell fork to a path that runs on every catalog compile. A symlink costs nothing.
codavox code-id <env>still works directly for interactive use.Documentation
New
docs/commands.mdcovers both commands, exit codes, the OpenVox Server wiring, on-disk layout, and the input validation rules — including the base64code_idtrap, where+and=are both valid base64 and both rejected by OpenVox Server at runtime.Docs now follow the OpenVox documentation style guide: American English,
consolefences for terminal commands, and OpenVox Server as the component name in prose while literal paths and service names keep their real spelling.CONTRIBUTING.mdrecords the style rules, the two load-bearing design invariants (no fallbacks;code-idstays a single read), and flags that GPG/DCO signing is not yet enforced — worth deciding before history accumulates, since retrofitting sign-off means a rebase.Verification
All CI checks were run locally before pushing: markdownlint clean,
golangci-lint0 issues,go test -race ./...green across all three packages.🤖 Generated with Claude Code