Skip to content
effect-gheffect-gh
Esc
↑↓navigate↵open⌘Jpreview
On this page

Development

Run the checks, review gh tooling drift and release the package.

Use the tool versions pinned in mise.toml and Bun for dependencies.

mise run check ::: build

Docs

mise run docs:dev
mise run docs:check

docs:dev runs the dev server, and docs:check checks the pages, links and types in an isolated folder so it doesn’t clash with a running dev server. Run bun run brand in docs to regenerate the logo PNGs and the GitHub social preview from src/assets/logo.svg.

Tooling drift

tooling.yml records the gh release the SDK was last reviewed against, and tooling/gh holds a snapshot of the help and --json fields of every wrapped command at that release. Upkeep’s drift job flags when a newer cli/cli release appears.

To review a new release, run mise run tooling:refresh <tag>, review the diff against the wrappers in src/, then set reviewed in tooling.yml and push. Add a command to the list in scripts/gh-contract.ts when the SDK starts wrapping it.

Releases

Run mise exec -- npm pack --dry-run to inspect the package locally. For a release, set the package version, keep bun.lock in sync and pass mise run check and mise run build. Commit and push the reviewed version, then publish a GitHub release with a tag matching the version exactly. The release workflow validates and builds the package, then publishes to npm with provenance.

Last updated on