Skip to content

fix: implement working NPM distribution with GitHub release workflow#25

Merged
Tristan578 merged 3 commits intomainfrom
fix/npm-distribution
Mar 15, 2026
Merged

fix: implement working NPM distribution with GitHub release workflow#25
Tristan578 merged 3 commits intomainfrom
fix/npm-distribution

Conversation

@Tristan578
Copy link
Copy Markdown
Owner

@Tristan578 Tristan578 commented Mar 15, 2026

Summary

  • Rewrote scripts/install.js to download pre-built binaries from GitHub Releases, detecting platform/arch automatically and using only Node.js built-in modules
  • Updated .github/workflows/release.yml to build player2-kanban binaries for linux-amd64, linux-arm64, darwin-amd64, darwin-arm64, and windows-amd64, packaging as .tar.gz (Unix) or .zip (Windows)
  • Added repository and files fields to package.json for proper npm publishing

Test plan

  • Push a v* tag and verify the release workflow builds all 5 platform targets
  • Verify release assets are named player2-kanban-{os}-{arch}.tar.gz (or .zip for Windows)
  • Run npm install from a published package and confirm the install script downloads and extracts the correct binary
  • Run npm install when no release exists and confirm a helpful build-from-source message is shown

…leases

Replace placeholder install script with a working implementation that
detects platform/arch, downloads the correct binary archive from GitHub
Releases, extracts it, and places it in ./bin/. Uses only Node.js
built-in modules. Falls back gracefully when no release exists yet.
…pport

Rename binary from taskboard to player2-kanban, add windows-amd64
build target, fix embedded frontend path to cmd/kanban, package Windows
builds as .zip and Unix builds as .tar.gz, and remove Homebrew tap step.
Add repository URL for npm registry linking and files whitelist to
ensure only bin/ and scripts/install.js are included in the published
package.
@Tristan578 Tristan578 merged commit e5ecddc into main Mar 15, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant