Skip to main content

Preparing Releases

Preparing Releases

Consequential Workflow

Move from an approved release state through version, changelog, commit, tag, and remote publication.

Commandcusty run release

Category

User Guide

Quick Command

custy --dry-run run release [OPTIONS]
preflightversionchangelogtagpush
Profile
release
Creates Commit
Yes
Creates Tag
Yes
Publishes Remotely
Yes

Goal​

Use Release when an approved version should be applied, documented, committed, tagged, and pushed. The profile validates release prerequisites and ends after push; it does not invoke Full's experimental finalization stage.

Release Readiness Checklist

Before You Begin

  • The release scope is approvedRequired

    Included changes, version intent, and publication timing are agreed.

  • Messages are reviewedRequired

    Commit and tag message files exist and satisfy the configured convention.

  • Version configuration is correctRequired

    Review the version file, strategy, bump behavior, and any explicit tag input.

  • Changelog policy is understoodRequired

    Confirm templates, mappings, final-version behavior, and output path.

  • Every remote is verifiedRequired

    Inspect origin, primary, backup, and synchronization policy before publication.

  • Recovery is plannedRequired

    Know how you will inspect a partial file update, commit, tag, or multi-remote push.

Release preflight
bash
git status --short --branch
git diff
git diff --staged
git tag --list
git remote -v
custy validate

Recommended Release Journey

Reviewed Publication

1
Validate readiness
Resolve repository, message, version, tag, and remote prerequisites.
completed
2
Preview the complete profile
Dry-run Release and read every resolved path, version, tag, and destination.
completed
3
Review editable artifacts
Confirm the intended commit message, tag message, version output, and changelog result.
completed
4
Execute Release
Run normally only after the preview and team release checks are complete.
current
5
Verify publication
Confirm local files, commit, tag, and every intended remote independently.
pending
Preview and publish
bash
custy --dry-run run release
custy run release

Release Completion Boundaries

State to Verify

Project Files

Version-bearing files, generated artifacts, and conditional CHANGELOG.md output.

Recovery Files

Commit and tag message backups after retention cleanup.

Local Git

The release commit and local release tag.

Remote State

HEAD and tag at every destination that was supposed to receive them.

The Release Pipeline documents the exact 24-step sequence. Changelog generation is present in that sequence but can still be skipped by active final-version and configuration rules.

Post-Release Verification

Verify local release state
bash
git status --short --branch
git log -1 --decorate --stat
git tag --points-at HEAD
git remote -v

Also verify the branch and tag through each repository host or an appropriate fetch-and-compare process. A successful push to one destination does not prove that every configured destination completed.

Continue

Related Commands

Commands commonly used together with this command.