diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 90dafb3..121621e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -85,7 +85,7 @@ jobs: - name: Build npm bundle run: bun run build - # @mantacode/mna-cli is a scoped package, which npm treats as private by + # mna-cli is a scoped package, which npm treats as private by # default — --access public is required (belt-and-braces alongside # publishConfig.access in package.json), especially on the first publish. - name: Publish to npm diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 39f5b99..f09e6c6 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -74,4 +74,4 @@ introduce tests that hit production unless they're explicitly opt-in (`MNA_E2E=1 See [RELEASING.md](./RELEASING.md). Releases are driven by pushing a `vX.Y.Z` tag, which builds the native binaries, cuts a GitHub Release, and publishes -`@mantacode/mna-cli` to npm. +`mna-cli` to npm. diff --git a/README.md b/README.md index 07b79d3..451704f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Releases. npm and Homebrew distribution land with the first tag. ### npm (Node 20+) ```bash -npm install -g @mantacode/mna-cli +npm install -g mna-cli ``` This installs the `mna` binary. It bundles all dependencies as a single @@ -24,7 +24,7 @@ JS file; no Bun required. ### Homebrew (macOS + Linux) ```bash -brew install mantacode/tap/mna +brew install akoso/tap/mna ``` Installs a precompiled native binary. The tap is updated per release; see diff --git a/RELEASING.md b/RELEASING.md index 8c3e10e..9781473 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -4,9 +4,9 @@ The release pipeline is driven by tag pushes. Tagging a commit `vX.Y.Z` runs `.github/workflows/release.yml`, which builds three native binaries (`darwin-arm64`, `darwin-x64`, `linux-x64`), uploads them to a GitHub Release as `.tar.gz` + `.sha256`, and publishes the bundled npm package -`@mantacode/mna-cli` to the public registry. +`mna-cli` to the public registry. -The npm package is `@mantacode/mna-cli`; the binary it installs is `mna`. +The npm package is `mna-cli`; the binary it installs is `mna`. The `@mantacode` scope is shared across products, so the package name carries the product prefix while the command stays short. @@ -29,7 +29,7 @@ the product prefix while the command stays short. 4. Watch the **Release** workflow on GitHub Actions. When it completes: - A new GitHub Release `vX.Y.Z` exists with three `mna-.tar.gz` assets and their `.sha256` files. - - npm has a new `@mantacode/mna-cli@X.Y.Z` version. + - npm has a new `mna-cli@X.Y.Z` version. 5. Refresh the Homebrew tap (see below). @@ -75,8 +75,8 @@ already carries `version "0.1.0"` as its placeholder. number is then burned (never reuse one). 3. **Create the Homebrew tap repo.** Make a public GitHub repo named - `mantacode/homebrew-tap` — the `homebrew-` prefix is what lets Homebrew - resolve `brew install mantacode/tap/mna`. Inside it, create + `akoso/homebrew-tap` — the `homebrew-` prefix is what lets Homebrew + resolve `brew install akoso/tap/mna`. Inside it, create `Formula/mna.rb` from this repo's `homebrew/mna.rb` template with the SHAs filled in (see next section). @@ -93,7 +93,7 @@ The tap is not automated yet. After every release: cat /tmp/mna-vX.Y.Z/mna-linux-x64.tar.gz.sha256 ``` -2. In a checkout of `mantacode/homebrew-tap`, edit `Formula/mna.rb`: +2. In a checkout of `akoso/homebrew-tap`, edit `Formula/mna.rb`: - Update `version "X.Y.Z"`. - Replace each `sha256 "..."` with the values from step 1. @@ -107,7 +107,7 @@ The tap is not automated yet. After every release: 4. Verify install works from a clean machine: ```bash - brew install mantacode/tap/mna + brew install akoso/tap/mna mna --version # should print X.Y.Z ``` @@ -118,7 +118,7 @@ that opens a PR against the tap repo from `release.yml`. - **GitHub Release:** `gh release delete vX.Y.Z --yes` and delete the tag (`git tag -d vX.Y.Z && git push --delete origin vX.Y.Z`). -- **npm:** `npm unpublish @mantacode/mna-cli@X.Y.Z` works only within +- **npm:** `npm unpublish mna-cli@X.Y.Z` works only within 72 hours of publish. After that, publish a new patch version with the fix. **Never** reuse a version number. - **Homebrew:** revert the formula commit in the tap repo. diff --git a/homebrew/mna.rb b/homebrew/mna.rb index 8fccad2..0f93946 100644 --- a/homebrew/mna.rb +++ b/homebrew/mna.rb @@ -1,8 +1,8 @@ # Template Homebrew formula for the mna CLI. # # This file is versioned alongside the source as a template. To make -# `brew install mantacode/tap/mna` work, copy this file into the separate -# `mantacode/homebrew-tap` GitHub repo at `Formula/mna.rb`, and update +# `brew install akoso/tap/mna` work, copy this file into the separate +# `akoso/homebrew-tap` GitHub repo at `Formula/mna.rb`, and update # `version` + each `sha256` after a new GitHub Release is published. # See RELEASING.md. diff --git a/package.json b/package.json index e86d8b6..6a1b98f 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@mantacode/mna-cli", + "name": "mna-cli", "version": "0.0.1", "description": "Command-line tool for My Next Adventure trip planning.", "license": "MIT",