rlsbl v0.40.1 /rlsbl.targets.base
Updated
On this page

Base class for release targets with shared defaults for version I/O, detection, scaffolding, publish, asset builds, and dev-install.

#rlsbl.targets.base

#rlsbl.targets.base

Base class for release targets providing shared defaults for version reading, writing, detection, scaffolding, and publish configuration.

#BaseTarget

Concrete base providing defaults for optional Protocol methods.

#version_file

python
def version_file(self)

#tag_format

python
def tag_format(self, version)

#monorepo_tag_format

python
def monorepo_tag_format(self, name, version, path=None)

#monorepo_tag_glob

python
def monorepo_tag_glob(self, name, path=None)

#template_dir

python
def template_dir(self)

#shared_template_dir

python
def shared_template_dir(self)

#read_name

python
def read_name(self, dir_path)

#read_metadata

python
def read_metadata(self, dir_path)

#template_vars

python
def template_vars(self, dir_path)

#template_mappings

python
def template_mappings(self)

#shared_template_mappings

python
def shared_template_mappings(self)

#check_project_exists

python
def check_project_exists(self, dir_path)

#get_project_init_hint

python
def get_project_init_hint(self)

#write_version

python
def write_version(self, dir_path, version)

Write a new version to the target's version file(s).

Returns a list of relative file paths (relative to dir_path) that were modified. Subclasses must override this method and return the actual paths written.

#build

python
def build(self, dir_path, version)

#publish

python
def publish(self, dir_path, version)

#build_assets

python
def build_assets(self, dir_path, version, dist_dir)

#dev_install_command

python
def dev_install_command(self, project_dir)

Specs for local install via rlsbl dev install, keyed by mode.

Subclasses override to return spec dicts for the "global" and/or "venv" modes. See the protocol docstring for the spec format. Default returns {"global": None, "venv": None} (unsupported).