Skip to content
rlsbl.pipelines.base
Updated
On this page

Base classes for release pipelines, including no-op defaults for optional methods and token/credential authentication mixins.

#rlsbl.pipelines.base

#rlsbl.pipelines.base

Base classes for release pipelines, including no-op defaults for optional methods and token/credential authentication mixins.

#BasePipeline

Concrete base providing no-op defaults for optional Pipeline methods.

Subclasses override specific methods to implement their publish mechanism.

#__init__

python
def __init__(self, name: str, pipeline_type: str, local: bool, config: dict)

Initialize with pipeline identity, local-publish flag, and config dict.

#probe_before_publish

python
def probe_before_publish(self, dir_path: str, version: str, ctx) -> bool

Probe the linked target's registry before publishing.

Returns True if publishing should proceed, False if already published (skip with log). Requires the pipeline to have a target attribute linking it to a target name.

#is_already_published_error

python
def is_already_published_error(exc: Exception) -> bool

Check if an exception represents an "already published" error.

Inspects the exception message, stdout, and stderr for known registry error signatures. When True, the caller should treat the error as success (idempotent).

#ci_secret_names

python
def ci_secret_names(self) -> list[str]

Repository secrets this pipeline's CI publish job authenticates with.

Empty when the pipeline publishes LOCALLY -- the credential is then the developer's own environment, which is what required_env_vars answers -- and empty when the workflow needs no repository secret.

#publish

python
def publish(self, dir_path: str, version: str, ctx) -> None

Publish the package. No-op by default; subclasses override.

#build_assets

python
def build_assets(self, dir_path: str, version: str, dist_dir: str, ctx) -> list[str]

Build release assets into dist_dir. Returns paths; empty by default.

#template_dir

python
def template_dir(self) -> str | None

Return the directory containing CI templates, or None if none.

#template_mappings

python
def template_mappings(self, ctx) -> list[dict[str, str]]

Return template-to-target mappings for CI scaffold. Empty by default.

#_linked_target_subdir

python
def _linked_target_subdir(self, ctx) -> str

Resolve the directory of this pipeline's linked target.

Reads ctx.config["targets"] for an entry whose name matches this pipeline's target link and returns its path ("." for a root target, or a subdirectory like "packaging/npm"). Returns "." when the target is unknown or ctx is unavailable (e.g. unit tests passing ctx=None).

#build_custom_assets

python
def build_custom_assets(self, dist_dir: str) -> list[str]

Build custom assets defined in the pipeline config.

Reads self.config["custom_assets"] (list of dicts with name and build keys), runs each build command via shell subprocess, verifies the output file exists, and checks its size against self.config["max_asset_size_mb"].

Returns a list of absolute paths to the built asset files. Returns an empty list if no custom_assets are configured.

#required_env_vars

python
def required_env_vars(self) -> list[str]

Return env var names required for local publish. Empty by default.

#TokenPipeline

Base for pipelines that authenticate via a single token env var.

Subclasses set _default_token_var and implement _publish_command.

#__init__

python
def __init__(self, name: str, pipeline_type: str, local: bool, config: dict)

Initialize and resolve the token env var from config or class default.

#publish

python
def publish(self, dir_path: str, version: str, ctx) -> None

Resolve the token and delegate to _publish_command.

#required_env_vars

python
def required_env_vars(self) -> list[str]

Return the token var when local publish is enabled.

#CredentialPipeline

Base for pipelines that authenticate via username/password env vars.

Subclasses set _default_username_var and _default_password_var and implement _publish_command.

#__init__

python
def __init__(self, name: str, pipeline_type: str, local: bool, config: dict)

Initialize and resolve username/password env vars from config or defaults.

#publish

python
def publish(self, dir_path: str, version: str, ctx) -> None

Resolve credentials and delegate to _publish_command.

#required_env_vars

python
def required_env_vars(self) -> list[str]

Return username and password vars when local publish is enabled.

More tools from this site

  • claudestream Drive Claude Code from Python: run it as a subprocess and read its output as typed events, with async and sync sessions, sandbox policies, and tools you define in Python
  • claudewheel A TUI Claude Code Launcher that lets you have more than one profile, manage sessions lifecycle, pick the exact CC version, model to use (even older unlisted ones), pick which GitHub account to use, etc.
  • dirstat Fast, single-binary directory statistics CLI: every file under a tree grouped by format, with counts, sizes, and lines of code, as a colored terminal table or as JSON
  • fastware A batteries-included ASGI framework: msgspec JSON, a managed Granian server, dependency injection, SSE, WebSockets, auth, and a test client
  • go-toml-edit Zero-dep TOML editing library for Go with comment preservation
  • howmuchleft The fastest Claude Code statusline: context window, 5-hour, and weekly limit usage as three customizable gradient bars, rendering in about 6 ms
  • orxtra
  • pgdesign
  • predraw Declarative rendering pipeline: describe a scene in JSON and get SVG, PNG and WebP out, with light and dark style tokens, reusable components and text converted to path outlines
  • reposummary Turn a git repository's history into a Markdown journal: pick a time window or revision range and get a readable digest of what changed, optionally narrated by an LLM
  • safegit git wrapper CLI that gives each commit its own temporary index and retries ref updates on conflict, so concurrent agents share one repository
  • saferm Command-line replacement for rm that archives every deletion with a mandatory reason and the context it ran in, so deleted files can be listed, inspected and restored
  • selfdoc Static Site Generator that builds a project's documentation site directly from its source code, so the docs can never drift from the code they describe, with SEO/AEO, first-class blog, search, and cross-project linking built in
  • strictcli
  • stricttest An always-on test-isolation floor: a pytest plugin and a Go env-hygiene module that make a test suite structurally unable to reach real credentials, the real HOME, the network, or the development repository.
  • wesktop A Python framework that turns an ASGI web app into a desktop application, serving it from a local Granian server and displaying it in a native OS window via pywebview
Search