Skip to main content

Commands, Pipelines, and Workflows

Commands, Pipelines, and Workflows

Essential

Choose the smallest Custy execution model that reaches the outcome you need.

Commandcusty COMMAND | custy run PROFILE

Category

Core Concepts

Quick Command

custy COMMAND [OPTIONS]
CLI modelpipeline resolutionworkflow policy
Command
One focused entry point
Pipeline
Ordered registered steps
Workflow
Policy and lifecycle
Workflow CLI
Experimental

Overview​

Custy exposes focused commands and reusable pipeline profiles through the same CLI. The terms describe different layers: a command is what you invoke, a pipeline is an ordered execution plan, and a workflow describes the broader release policy or lifecycle that coordinates work.

Three Different Layers

Keeping these layers separate makes command behavior and side effects easier to predict.

Execution Model

Command

A public CLI entry point such as custy validate, custy commit, or custy changelog generate.

Pipeline

A resolved, globally ordered list of registered steps. Public profile names are expanded before execution begins.

Workflow

The policy and lifecycle surrounding preparation, review, release, and finalization. It is broader than one command or profile.

How a Run Profile Becomes a Pipeline

Pipeline Resolution

1
Select public profiles
Pass one or more supported names to custy run.
current
2
Expand profile definitions
Custy replaces each profile name with its configured internal step list.
pending
3
Merge and deduplicate
When profiles overlap, repeated steps are included only once.
pending
4
Apply global ordering
The resolver sorts the combined steps into Custy's required execution order.
pending
5
Execute sequentially
The pipeline builds registered step objects and runs them one after another.
pending

Public Run Profiles

The current public custy run argument accepts six profile names:

Supported Profiles

Commit

Prepare project artifacts and create a local commit.

Tag

Prepare version state and create a local tag.

Push

Synchronize HEAD and an optional tag with resolved remotes.

Dev

Validate and review the commit message, create a commit, and push branch HEAD without release side effects.

Release

Apply a version, commit, tag, and push a release.

Full

Run Release and then invoke experimental finalization.

Internal resolver profiles are implementation details. A profile appearing in source code or broad help text does not mean the typed public custy run argument accepts it.

Choose an execution model
bash
# One focused operation
custy changelog generate

# One supported coordinated pipeline

custy --dry-run run dev

# Multiple public profiles are merged into one ordered pipeline

custy --dry-run run commit push

Choose the Smallest Suitable Operation

  • Choose a direct command when you need its command-specific inputs or one focused result.
  • Choose custy run PROFILE when the desired result spans multiple registered stages.
  • Combine public profiles only when you understand their merged requirements and side effects.
  • Treat the workflow command group as experimental until its documented limitation is resolved.

Continue

Related Commands

Commands commonly used together with this command.

Pipeline Guide

Understand resolution, execution, profile flows, and internal steps.