Skip to content

release

Interactive package release.

Usage

shell
rt release

Config

ts
import { defineConfig } from 'rattail/vite-plus'

export default defineConfig({
  rattail: {
    release: {
      // skipNpmPublish: true,
      // skipChangelog: true,
    },
  },
})

Programmatic Usage

ts
import { release } from 'rattail/cli'

await release({
  // skipNpmPublish: true,
  // skipChangelog: true,
})

Options

OptionTypeDefaultDescription
npmTagstring-npm dist-tag for publishing, e.g. beta, next. Defaults to latest if not set
skipNpmPublishboolean-Skip npm publish
skipChangelogboolean-Skip changelog generation
skipGitTagboolean-Skip git tag
checkRemoteVersionboolean-Check npm remote version before publishing, skip if version already exists
task(newVersion, oldVersion) => Promise<void>-Custom task to run after version update but before npm publish, e.g. build
remotestringoriginGit remote name for pushing, rarely needs to be changed