Skip to main content

97 docs tagged with "custy"

View all tags

Adding Commands

Add a Custy CLI command while preserving option, model, resolver, core, registration, and test boundaries.

Adding Version Strategies

Add and integrate a Custy version-tag strategy across the protocol, CLI enum, workflow dispatch, tests, and documentation.

Architecture Overview

Understand Custy's active runtime layers, dependency flow, subsystem boundaries, and architectural trade-offs.

Backup Cleanup

Configure which message backups Custy cleans and how many recent files it keeps.

Branch Cleanup

Configure layered prefix, merge-state, age, and date filters for branch cleanup.

Breaking Changes

Configure breaking-change enablement, keyword detection, and the rendered section label.

Changelog System

Trace Custy's active changelog flow from Git ranges and message providers through semantic processing, release planning, Jinja rendering, and file output.

Changelog Troubleshooting

Resolve missing or duplicate entries, incorrect release ranges, noisy grouping, pending-content limitations, broken links, template errors, and unexpected output.

Cleaning Branches

Preview layered Custy branch filters before deleting matching local and remote branches.

Cleaning Rules

Configure presentation-only removal of separators, headings, summaries, metadata, and keywords.

CLI Layer

Trace Custy's Typer entrypoints, command registration, global context, argument resolution, and core delegation.

CLI Reference

Find every active Custy root command, command group, subcommand, entrypoint, and documentation route.

Command Reference

Find the supported Custy commands for project setup, validation, versioning, changelogs, Git operations, and pipelines.

Commit Validation

Choose Custy, Commitizen, automatic discovery, or basic Git message-file checks.

Configuration File

Understand how Custy creates, loads, owns, and safely replaces project configuration.

Configuration Overview

Navigate every Custy configuration namespace, table, property, default, and implementation status.

Configuration Reference

Reference Custy's project-owned TOML root, namespaces, precedence, lifecycle, cache boundary, and implementation-status language.

Configuration Resolution

Understand how Custy resolves explicit CLI values, project configuration, and built-in defaults.

Configuration System

Trace Custy configuration from packaged initialization resources through TOML loading, precedence, typed subsystem models, and runtime consumers.

Configuration Troubleshooting

Resolve missing or invalid TOML, wrong working directories, unexpected precedence, stale cached values, path errors, templates, and initialization replacements.

Console Logging

Configure console threshold, Rich presentation, timestamps, levels, and formatting.

Contributing

Prepare a focused, tested, documented, and reviewable contribution to Custy.

Core Collection

Configure merge-commit and Conventional Commit type exclusion before changelog processing.

Core Layer

Understand Custy's orchestration and domain subsystems, their responsibilities, dependencies, and current coupling.

Custom Composition

Understand how Custy merges public profiles, removes duplicate steps, and enforces global order.

Custy

Automate repeatable Git, versioning, changelog, backup, cleanup, and release workflows from one configurable CLI.

Developer Guide

Set up Custy for development, understand its extension points, test changes, and prepare focused contributions.

Development Pipeline

Understand the exact Dev profile phases, side effects, omissions, and recovery boundary.

Development Setup

Prepare a Python 3.14+ environment, install Custy in editable mode, and verify contributor tools.

Documentation Status

See which Custy release this documentation represents, when it was reviewed, and how to compare another installed version.

Dry Run

Preview supported Custy mutations while allowing discovery, validation, and resolution to continue.

Editor

Configure editor precedence for commit and tag message review on local hosts and inside containers.

Environment

Reference Custy's runtime tools, working-directory assumptions, external editor behavior, theme variables, Git authentication boundary, and terminal compatibility.

Errors and Exit Status

Reference Custy's current success, usage, explicit exit, validation, pipeline, Git, configuration, cleanup, and unexpected-error behavior.

Execution

Configure cross-command preview, force, debugging, staging, and validation defaults.

Execution Model

Follow how Custy resolves, builds, and executes a pipeline and how failures are handled.

Extending Configuration

Carry a new Custy setting from the packaged TOML template through resolution, runtime use, tests, and documentation.

File Logging

Configure Custy's persistent rotating log file, size, retention, and format.

Full Pipeline

Understand Release plus Custy's experimental post-push branch workflow finalization.

Getting Started

Install Custy, prepare an existing Git repository, and preview your first development pipeline safely.

Git Commit Hooks

Choose safe native or direct pre-commit execution for local and container workflows.

Git Operations

Trace Custy's Git factory, executor protocol, high-level service, result models, dry-run boundary, tag sorting, and consumers.

Git Overview

Navigate service-level remote groups and push strategy under tool.custy.git.

Git Push Strategy

Configure service-level main, backup, or all selection and understand reserved auto-push behavior.

Git Remotes

Configure Custy's default remote plus primary and optional backup remote groups.

Git Troubleshooting

Resolve repository detection, staging, commit, tag, remote, authentication, push, branch, and cleanup problems safely.

Global Options

Reference Custy's root options, aliases, placement, configuration resolution, defaults, and current exit behavior.

Initialization

Configure Custy's default overwrite and confirmation behavior during project initialization.

Logging Overview

Navigate Custy's Rich console and rotating file logging configuration.

Managing Backups

Create, verify, retain, clean, and restore Custy's commit and tag message backups.

Paths

Configure the version source used by Custy commands.

Paths and Files

Reference Custy's project configuration, templates, version file, changelog, backups, logs, packaged resources, and working-directory behavior.

Pending Commit

Configure whether and how the project commit-message file joins generated history.

Pipeline Engine

Understand Custy's profiles, expansion, global ordering, step registry, builders, shared context, and sequential execution.

Pipeline Guide

Understand Custy's public profiles, execution model, safety boundaries, and extension points.

Pipeline Profiles

Reference Custy's six public Run profiles, direct-command profiles, internal composition profiles, step counts, and ordering rules.

Preparing Releases

Prepare, preview, publish, and verify a versioned Custy release without treating it as one atomic action.

Project

Configure the primary Custy project source directory.

Public Pipeline Profiles

Compare the six public Custy Run profiles and navigate the complete 20-profile resolver catalog.

Push Defaults

Configure direct and pipeline push defaults under tool.custy.cli.push.

Reference

Use concise, source-aligned indexes for Custy's CLI, global options, configuration, version formats, pipeline profiles, paths, environment, and exit behavior.

Release Lifecycle

Understand how Custy's Release profile progresses from preflight validation to versioning, changelog generation, commit, tag, and push.

Release Metadata

Understand generated release metadata and its current compatibility boundary.

Release Pipeline

Understand Custy's complete validated version, changelog, commit, tag, and push sequence.

Rendering

Configure all 28 changelog visibility, layout, formatting, sorting, and visual properties.

Resolution and Status

Understand Custy's effective-value priority and how documentation status maps to implementation.

Safety and Side Effects

Classify Custy's local, Git, interactive, and remote effects and review a practical execution checklist.

Step System

Developer guide to Custy's BaseStep, registry, builder, shared context, ordering, and tests.

Strategy Pattern

Understand Custy's separate strategies for generating version tags, sorting existing tags, and converting version formats.

Template Files

Configure changelog, commit-message, and tag-message file paths.

Testing

Choose focused Custy tests, understand the suite layers, and run complete validation before review.

Troubleshooting

Diagnose Custy failures from the first symptom, inspect current state, correct the smallest cause, and verify recovery safely.

Troubleshooting Workflows

Recover safely by identifying the last successful Custy effect before retrying a command or profile.

User Guide

Complete common Custy tasks safely, from daily development and releases to backups, branch cleanup, and recovery.

Version Formats

Reference Custy's SemVer, PEP 440, Commitizen, date, and Git-count forms, stage detection, basic conversion, generation, and sorting boundaries.

Versioning

Understand how Custy resolves a release version, prepares artifacts, updates project files, and later creates a Git tag.

Versioning

Configure version strategy, bump behavior, and optional date-tag formatting.

Versioning Troubleshooting

Resolve missing version files, invalid strategies, unexpected formats, conversion limits, Commitizen failures, tag conflicts, and unapplied updates.

Workflow Engine

Understand WorkflowConfig, WorkflowEngineBuilder, service construction, phase methods, runtime state, and finalization behavior.

Workflow Troubleshooting

Resolve rejected profiles, normalized ordering, validation stops, partial pipelines, inactive option adapters, failed publication, and experimental workflow behavior.