Skip to content

changelog

Symbol Details

cli_command: release_notes

def release_notes(*, tag_name: str = ...):
    ...

CLI Options:

Flag Type Default Description
--tag str required tag to find release notes for

Changes

Version Change
0.1.0 Made public

cli_command: chore

def chore(*, description: str = ..., pr_number: int = 0):
    ...

Create a ChoreAction for internal changes that warrant a release.

CLI Options:

Flag Type Default Description
--description, -d str required Description of internal changes (e.g., 'CI improvements', 'Dependency updates')
--pr int 0 PR number (auto-detected from current branch if not provided)

Changes

Version Change
0.1.0 Made public

cli_command: promote

def promote(*, name: str | None = ..., group: str | None = ..., module_filter: str | None = ..., pattern: str | None = ..., undecided: bool = False, pr_number: int = 0):
    ...

Promote symbols to public API (private or undecided).

CLI Options:

Flag Type Default Description
--name, -n str | None required Symbol name to promote
--group, -g str | None required Target group
--module, -m str | None required Filter by module path prefix (inside the package, don't include the package name)
--pattern, -p str | None required Filter by name pattern (e.g., 'dump_*')
--undecided, -u bool False Include symbols without changelog entry (not yet decided)
--pr int 0 PR number (auto-detected if not provided)

Changes

Version Change
0.1.0 Made public