Skip to content

publishing.md

Latest commit

 

History

History
80 lines (64 loc) · 1.96 KB

publishing.md

File metadata and controls

80 lines (64 loc) · 1.96 KB

Publishing Checklist

Publishing checklist and workflow. First published as v0.7.0 on 2026-03-14.

Setup (completed)

  • Package name summon-ws chosen (npm)
  • bin entry for summon
  • files: ["dist"] limits published contents
  • engines: { "node": ">=18" }
  • os: ["darwin"] enforces macOS-only
  • prepublishOnly runs pnpm run build
  • license: "MIT" + LICENSE file
  • Zero runtime dependencies
  • CI pipeline (typecheck + build + test)
  • keywords for npm discoverability
  • repository, homepage, bugs fields in package.json
  • README.md

Publishing a New Version

1. Pre-Publish Verification

pnpm pack
# Inspect the tarball contents:
tar tzf summon-ws-<version>.tgz
# Should contain: package/dist/index.js, package/package.json,
#                 package/README.md, package/LICENSE
# Should NOT contain: docs/, src/, node_modules/

# Install globally from the tarball:
npm i -g ./summon-ws-<version>.tgz

# Verify command works:
summon --version
summon --help

# Test a real launch (requires Ghostty running):
summon .

# Clean up:
npm uninstall -g summon-ws
rm summon-ws-<version>.tgz

3. Real Ghostty Test

  • Test on a Mac with Ghostty 1.3.1+
  • Verify AppleScript permission prompt appears and works
  • Verify all presets create correct layouts
  • Verify commands run in correct panes

4. Version Strategy

  • Follow semver: breaking changes = major, features = minor, fixes = patch
  • The project is stable (1.x). Minor releases add features, patch releases fix bugs.

5. Publish

# Dry run first:
npm publish --dry-run

# If everything looks good:
npm publish

# Verify it's live:
npm info summon-ws

6. Post-Publish Verification

# Install from npm:
npm i -g summon-ws
summon --version
summon --help
summon .

7. GitHub Release

  • Tag the commit: git tag v<version>
  • Push the tag: git push origin v<version>
  • Create a GitHub release from the tag