@releasekit/publish

Publish packages to npm and crates.io with git tagging and GitHub releases.

Features

• npm publishing with OIDC provenance support
• crates.io publishing for Rust packages
• Git tagging with customizable tag templates
• GitHub releases with auto-generated notes
• Retry logic for flaky registry operations
• Dry-run mode for safe testing
• JSON output for CI integration
• Post-publish verification to confirm packages are available

Installation

npm:

npm install -g @releasekit/publish

pnpm:

pnpm add -g @releasekit/publish

Note: This package is ESM only and requires Node.js 20+.

Quick Start

@releasekit/publish reads JSON output from @releasekit/version and runs a publish pipeline:

# Pipe from version to publish
releasekit-version --json | releasekit-publish

# Or use an input file
releasekit-version --json > version-output.json
releasekit-publish --input version-output.json

Pipeline Stages

The publish pipeline runs in order:

1. Input - Parse version JSON from stdin or file
2. Prepare - Copy files (e.g., LICENSE), update Cargo.toml versions
3. Git Commit - Create version bump commit
4. Git Tag - Create git tags for each package
5. npm Publish - Publish to npm registry
6. Cargo Publish - Publish to crates.io
7. Verify - Verify packages are available on registries
8. Git Push - Push commits and tags to remote
9. GitHub Release - Create GitHub releases

The pipeline is fail-fast: the first package publish failure throws immediately. Git push and GitHub release are skipped, so the version commit and tag remain local until the issue is fixed and the release is retried.

CLI Reference

| Flag | Description | Default | |------|-------------|---------| | --input <path> | Path to version output JSON | stdin | | --config <path> | Path to releasekit config | releasekit.config.json | | --registry <type> | Registry to publish to: npm, cargo, all | all | | --npm-auth <method> | NPM auth method: oidc, token, auto | auto | | --dry-run | Simulate all operations | false | | --skip-git | Skip git commit/tag/push (also skips GitHub release — no tag to release against) | false | | --skip-publish | Skip registry publishing | false | | --skip-github-release | Skip GitHub Release creation | false | | --skip-verification | Skip post-publish verification | false | | --json | Output results as JSON | false | | --verbose | Verbose logging | false |

Integration with @releasekit/version

Pipe Directly

releasekit-version --json --dry-run | releasekit-publish --dry-run

Use Output File

releasekit-version --json > version-output.json
releasekit-publish --input version-output.json

In CI (GitHub Actions)

- name: Configure permissions (OIDC + git pushes)
  # at job level:
  # permissions:
  #   id-token: write
  #   contents: write

- name: Version
  run: releasekit-version --json > version-output.json

- name: Publish
  run: releasekit-publish --input version-output.json
  # For OIDC trusted publishing: no npm token needed (recommended).
  # For token-based publishing: set NPM_TOKEN (or NODE_AUTH_TOKEN).
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Configuration

Configure via releasekit.config.json:

{
  "publish": {
    "npm": {
      "enabled": true,
      "auth": "auto",
      "provenance": true,
      "access": "public",
      "copyFiles": ["LICENSE"]
    },
    "git": {
      "pushMethod": "auto",
      "httpsTokenEnv": "GITHUB_TOKEN"
    },
    "cargo": {
      "enabled": false,
      "noVerify": false
    },
    "githubRelease": {
      "enabled": true,
      "draft": true,
      "body": "auto"
    },
    "verify": {
      "npm": {
        "maxAttempts": 5,
        "initialDelay": 15000
      },
      "cargo": {
        "maxAttempts": 10,
        "initialDelay": 30000
      }
    }
  }
}

See @releasekit/config for full configuration options.

Documentation

Guides

• GitHub Releases — release body options, LLM prose, draft workflow

License

MIT