build(cli): compile and publish standalone cross-platform binaries to GitHub Releases

Open
#166 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
bun, github-actions, node.js, typescript

Research direction

Start with the release workflow in .github/workflows/release.yml and the packages/cli build setup, then review dependency #11 to understand how releases and tags are created. Add the standalone compilation and matrix release steps described in the issue, and verify completion with release assets plus a containerized smoke test that runs without Node.js installed.

Written by the indexing model from the issue text.

Description

scope: cli type: build type: ci

Problem & Motivation

Canons (SPEC.md) are language- and ecosystem-agnostic Markdown specifications. However, non-JavaScript repositories (e.g., Rust, Go, Python, C++) face high adoption friction if running canon-clerk requires installing Node.js, npm, and maintaining a local package.json.

To enable zero-dependency adoption across any repository, CI pipeline, or pre-commit hook, we should compile and distribute standalone platform executables.


Proposed Solution

  1. Compilation Pipeline:

    • Configure a build step (via Node.js SEA [Single Executable Applications] or Bun cross-compilation) to generate standalone, single-file executables for:
      • canon-clerk-linux-x64
      • canon-clerk-linux-arm64
      • canon-clerk-darwin-x64
      • canon-clerk-darwin-arm64
      • canon-clerk-windows-x64.exe
  2. Automated Release Distribution:

    • In .github/workflows/release.yml, after release-please cuts a GitHub Release, run a matrix build job to compile the target binaries and upload them as release assets.
  3. Verification:

    • Ensure binaries execute cleanly in clean containers with zero pre-installed runtime dependencies (no Node.js on $PATH).

Dependencies & Pre-requisites

  • Blocked by #11: Depends on release-please workflow landing first so that GitHub Releases and tags are created automatically.

Acceptance Criteria

  • Standalone compilation script added for packages/cli.
  • Multi-platform matrix build job added to release workflow.
  • Binaries uploaded as assets to GitHub Releases alongside npm publishing.
  • Basic containerized smoke test verifying standalone binary execution without host Node.js.
Dominant language
Rust
Stars
0
Forks
1
Avg merge
1h 6m
Merged PRs (30d)
50

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PAIR-code/canon-clerk

All issues in PAIR-code/canon-clerk

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.