rlsbl v0.40.1 /rlsbl.release_file
On this page

Release file reader and validator for file-based releases.

#rlsbl.release_file

#rlsbl.release_file

Release file reader and validator for file-based releases.

Instead of passing bump type on the CLI, the user creates .rlsbl/releases/unreleased.toml describing the release. This module reads and validates that file's internal consistency.

#ReleaseConfig

ReleaseConfig
FieldTypeDefault
bumpstr
includelist[str]
excludelist[str]
targetsdict[str, dict]field(default_factory=dict)

#get_release_file_path

python
def get_release_file_path(project_dir: str='.') -> str

Return the path to .rlsbl/releases/unreleased.toml relative to project_dir.

#read_release_file

python
def read_release_file(path: str) -> ReleaseConfig

Read and validate a release TOML file.

Raises FileNotFoundError if the file doesn't exist. Raises ValueError for schema/validation failures.

#BatchReleaseConfig

Configuration from a batch release TOML file (monorepo).

#get_batch_release_file_path

python
def get_batch_release_file_path(workspace_root: str='.') -> str

Return the path to .rlsbl-monorepo/releases/unreleased.toml.

#read_batch_release_file

python
def read_batch_release_file(path: str) -> BatchReleaseConfig

Read and validate a batch release TOML file.

Expects [packages.] sections, each with the same fields as a single ReleaseConfig (bump, include, exclude, optional targets).

Raises FileNotFoundError if the file doesn't exist. Raises ValueError for schema/validation failures.