zuke.tools.release_please

← Python API reference

@zuke/release-please 1.0.3: @zuke/release-please — typed ReleasePleaseTasks wrappers for the [release-please](https://github.com/googleapis/release-please) CLI, for use in Zuke builds (maintaining release PRs and cutting GitHub releases).

zuke on PyPI ↗ 4 symbols

Symbols

#

ReleasePleaseGithubReleaseSettings

class 
class ReleasePleaseGithubReleaseSettings(ReleasePleaseSettings)

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

#

ReleasePleaseReleasePrSettings

class 
class ReleasePleaseReleasePrSettings(ReleasePleaseSettings)

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

#

ReleasePleaseSettings

class 
class ReleasePleaseSettings(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.

  • token(value: str) -> Self

    GitHub access token (--token).

  • repo_url(value: str) -> Self

    The repository, as owner/repo or a URL (--repo-url).

  • target_branch(value: str) -> Self

    The branch to release from (--target-branch).

  • config_file(path: str) -> Self

    Path to the release-please config file (--config-file).

  • manifest_file(path: str) -> Self

    Path to the release-please manifest file (--manifest-file).

  • dry_run() -> Self

    Print actions without performing them (--dry-run).

  • debug() -> Self

    Emit verbose debug logging (--debug).

#

ReleasePleaseTasks

class 
class ReleasePleaseTasks

Typed task functions for the release-please CLI.

  • static async release_pr(ctx: ServiceContext, configure: Callable[[ReleasePleaseReleasePrSettings], ReleasePleaseReleasePrSettings] | None=None) -> ExecResult

    Create or update the release PR: release-please release-pr.

  • static async github_release(ctx: ServiceContext, configure: Callable[[ReleasePleaseGithubReleaseSettings], ReleasePleaseGithubReleaseSettings] | None=None) -> ExecResult

    Cut GitHub releases and tags: release-please github-release.