rlsbl v0.113.0 /rlsbl.targets.pgdesign
Updated
On this page

Pgdesign release target for projects using pgdesign to manage PostgreSQL database schemas, with version tracking in pgdesign.toml.

#rlsbl.targets.pgdesign

#rlsbl.targets.pgdesign

Pgdesign release target for projects using pgdesign to manage database schemas, with version tracking in pgdesign.toml.

#PgdesignTarget

Release target for pgdesign database schema projects.

Detects pgdesign.toml in the project root or schema/ subdirectory. Version is stored in [project] version within pgdesign.toml. On release, validates the schema and generates migrations if configured.

#name

python
def name(self)

#detect

python
def detect(self, dir_path)

True if pgdesign.toml exists in root or schema/ subdir.

#_toml_path

python
def _toml_path(self, dir_path)

Resolve the actual path to pgdesign.toml.

#_schema_dir

python
def _schema_dir(self, dir_path)

Resolve the directory containing pgdesign.toml.

#read_name

python
def read_name(self, dir_path, ctx)

Return the directory name as the project name.

#read_metadata

python
def read_metadata(self, dir_path)

Pgdesign projects have no standard metadata beyond version.

#read_version

python
def read_version(self, dir_path)

Read version from pgdesign.toml [project].version.

#write_version

python
def write_version(self, dir_path, version, ctx)

Update [project].version in pgdesign.toml using tomlkit round-trip.

Returns a list of relative file paths (relative to dir_path) that were modified.

#version_file

python
def version_file(self, dir_path=None)

#build

python
def build(self, dir_path, version, *, config=None)

Validate the pgdesign schema. Fails the release if errors exist.

pgdesign 0.12.0 removed the validate command in favour of the check framework. pgdesign check --tag validation takes no positional path: it resolves the project from the process working directory (its check context root is the cwd, and config discovery only walks UP from there). The schema directory the old positional argument carried is therefore expressed as cwd -- which matters when pgdesign.toml lives in a schema/ subdir, since discovery would never find it from dir_path.

--ignore-warnings is always passed: pgdesign's check framework exits nonzero on warn-severity results, and warnings are advisory under its own severity model. Only errors are release-blocking, so warnings must never abort a release.

#template_vars

python
def template_vars(self, dir_path, ctx)

Extract template variables.

#template_dir

python
def template_dir(self)

#template_mappings

python
def template_mappings(self, ctx)
Search