Skip to content

PACKAGING.md

Latest commit

 

History

History
78 lines (59 loc) · 2.99 KB

PACKAGING.md

File metadata and controls

78 lines (59 loc) · 2.99 KB
Raw

Packaging (Homebrew, winget)

Third-party install manifests live under packaging/. They pin GitHub Release binaries. WinGet and Homebrew tap updates are submitted automatically after each published v*.*.* release.

Release packaging checklist

After a GitHub Release is published (see RELEASING.md):

  1. Confirm platform archives and SHA256SUMS on the release.

  2. Confirm Publish to WinGet ran (requires WINGET_TOKEN) and opened/updated the winget-pkgs PR.

  3. Confirm Publish to Homebrew tap ran (requires HOMEBREW_TAP_TOKEN) and pushed Formula/numan.rb to numan-cli/homebrew-numan.

  4. Spot-check on a Mac or Linux Homebrew host:

    brew tap numan-cli/numan https://github.com/numan-cli/homebrew-numan
brew update
brew install numan
numan --version

Manual Homebrew dry-run (no tap push):

gh release download vX.Y.Z --pattern SHA256SUMS
python3 scripts/render_homebrew_formula.py --version X.Y.Z --sha256sums SHA256SUMS --write

Install channels

Channel Command
GitHub Release Download archive from Releases
crates.io cargo install numan-cli
From git cargo install --git https://github.com/numan-cli/numan
Homebrew (tap) brew tap numan-cli/numan https://github.com/numan-cli/homebrew-numan && brew install numan
winget (community) winget install tonythethompson.numan

Archive layout

Release archives extract to numan-<version>-<target>/ containing the numan (or numan.exe) binary. Homebrew and winget installers assume this layout.

Installation coverage

Installation channel Linux x86_64 Linux aarch64 macOS Apple Silicon Windows x86_64 Windows ARM64
GitHub release archive yes yes yes yes yes
cargo install numan-cli source build source build source build source build not validated
Homebrew tap yes yes yes — —
winget — — — yes yes

Secrets

Secret Purpose
WINGET_TOKEN Open winget-pkgs update PRs
HOMEBREW_TAP_TOKEN Push formula updates to numan-cli/homebrew-numan

The Homebrew tap repository must stay public. Private visibility is why brew tap numan-cli/numan previously failed for most users.

If brew update fails with Host key verification failed for this tap, the local clone is on an SSH remote and can leave an old formula installed. Uninstall the stale formula first so brew untap can proceed, then recover with:

brew uninstall numan
brew untap numan-cli/numan
brew tap numan-cli/numan https://github.com/numan-cli/homebrew-numan
brew install numan-cli/numan/numan

Scoop is not packaged yet; see Phase7Plan.md.