@zuke/release-please

`@zuke/release-please` — typed `ReleasePleaseTasks` wrappers for the

Symbols

# ReleasePleaseGithubReleaseSettings class

class ReleasePleaseGithubReleaseSettings extends ReleasePleaseSettings

Settings for release-please github-release (cut releases and tags).

# ReleasePleaseReleasePrSettings class

class ReleasePleaseReleasePrSettings extends ReleasePleaseSettings

Settings for release-please release-pr (maintain the release PR).

# ReleasePleaseSettings class

class ReleasePleaseSettings extends ToolSettings

Shared base for release-please subcommands. Each subcommand contributes its leading token via subcommand; the common --token/--repo-url/… flags live here since release-pr and github-release accept the same set.

Member	Signature	Doc
`token`	`token(value: string): this`	GitHub access token (`--token`).
`repoUrl`	`repoUrl(value: string): this`	The repository, as `owner/repo` or a URL (`--repo-url`).
`targetBranch`	`targetBranch(value: string): this`	The branch to release from (`--target-branch`).
`configFile`	`configFile(path: PathLike): this`	Path to the release-please config file (`--config-file`).
`manifestFile`	`manifestFile(path: PathLike): this`	Path to the release-please manifest file (`--manifest-file`).
`dryRun`	`dryRun(): this`	Print actions without performing them (`--dry-run`).
`debug`	`debug(): this`	Emit verbose debug logging (`--debug`).

# ReleasePleaseTasks const

const ReleasePleaseTasks: ReleasePleaseTasksApi

Typed task functions for the release-please CLI.

# ReleasePleaseTasksApi interface

interface ReleasePleaseTasksApi

The shape of ReleasePleaseTasks.

Member	Signature	Doc
`releasePr`	`releasePr(configure?: Configure<ReleasePleaseReleasePrSettings>): Promise<CommandOutput>`	Create or update the release PR: `release-please release-pr`.
`githubRelease`	`githubRelease(configure?: Configure<ReleasePleaseGithubReleaseSettings>): Promise<CommandOutput>`	Cut GitHub releases and tags: `release-please github-release`.