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
| Field | Type | Default |
|---|---|---|
bump | str | |
include | list[str] | |
exclude | list[str] | |
targets | dict[str, dict] | field(default_factory=dict) |
#get_release_file_path
def get_release_file_path(project_dir: str='.') -> strReturn the path to .rlsbl/releases/unreleased.toml relative to project_dir.
#read_release_file
def read_release_file(path: str) -> ReleaseConfigRead 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
def get_batch_release_file_path(workspace_root: str='.') -> strReturn the path to .rlsbl-monorepo/releases/unreleased.toml.
#read_batch_release_file
def read_batch_release_file(path: str) -> BatchReleaseConfigRead and validate a batch release TOML file.
Expects [packages.
Raises FileNotFoundError if the file doesn't exist. Raises ValueError for schema/validation failures.