build(cli): compile and publish standalone cross-platform binaries to GitHub Releases
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
- Domain
- build-system, ci-cd, cli, release
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
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
-
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-x64canon-clerk-linux-arm64canon-clerk-darwin-x64canon-clerk-darwin-arm64canon-clerk-windows-x64.exe
- Configure a build step (via Node.js SEA [Single Executable Applications] or Bun cross-compilation) to generate standalone, single-file executables for:
-
Automated Release Distribution:
- In
.github/workflows/release.yml, afterrelease-pleasecuts a GitHub Release, run a matrix build job to compile the target binaries and upload them as release assets.
- In
-
Verification:
- Ensure binaries execute cleanly in clean containers with zero pre-installed runtime dependencies (no Node.js on
$PATH).
- Ensure binaries execute cleanly in clean containers with zero pre-installed runtime dependencies (no Node.js on
Dependencies & Pre-requisites
- Blocked by #11: Depends on
release-pleaseworkflow 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
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PAIR-code/canon-clerk
-
scope: canons scope: cli type: ci
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PAIR-code/canon-clerk#334 ·
Maintainers usually reply within 1 day
-
scope: canons type: refactor
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
PAIR-code/canon-clerk#297 ·
Maintainers usually reply within 1 day
-
scope: canons type: chore
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
PAIR-code/canon-clerk#229 ·
Maintainers usually reply within 1 day
-
scope: canons type: chore
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
PAIR-code/canon-clerk#228 ·
Maintainers usually reply within 1 day
-
scope: canons type: spec
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
PAIR-code/canon-clerk#105 ·
Maintainers usually reply within 1 day
All issues in PAIR-code/canon-clerk
Similar issues
-
priority: low
Difficulty 1/5 1-3 hours Newbie friendliness 83/100
storytold/vectorcraft#8387 · 2 comments ·
Maintainers usually reply within 1 day
-
area:desktop kind:test priority:p3 ready
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
obi1kenobi/cargo-semver-checks#1814 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
BurntSushi/jiff#715 ·
Maintainers usually reply within 1 day