Skip to content
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 directory being scanned. A project whose schema lives in a subdirectory declares that subdirectory as the target path in .rlsbl/config.json -- detection never walks down looking for it. 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 dir_path itself.

#_toml_path

python
def _toml_path(self, dir_path)

The pgdesign.toml path for dir_path; existence is not checked.

#_require_toml_path

python
def _require_toml_path(self, dir_path)

Return the pgdesign.toml path, or raise naming the remedy.

The error fires here, in resolution, rather than in detection: detection runs over every directory in a repository, so a schema subdirectory nobody declared must be invisible to it. Once a pgdesign target IS declared, the file it names has to exist, and the remedy for a schema in a subdirectory is the explicit target path.

#read_name

python
def read_name(self, dir_path, ctx)

Return the directory name as the project name.

#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 -- and that directory is dir_path, which for a schema in a subdirectory is the declared target 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)

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