Safety and Side Effects

🚀Safety and Side Effects

Required Review

Understand file changes, Git history, remote operations, prompts, and retry risks before running a profile.

Commandcusty run

📦Category

Pipeline

🚀Quick Command

custy --dry-run run PROFILE

---

safetyside effectsrecovery

---

Overview

The selected profile determines which files, Git references, and remotes can be affected. Combined profiles take the union of those effects.

---

Possible Side Effects

✨Pipeline Effect Categories

📄Project Files

Generate artifacts, update the version file, and create or replace changelog content.

📦Backups and Index

Create and prune message backups and stage tracked or untracked files.

🌿Git History

Create a local commit and tag when included by the selected profiles.

🌐Remote State

Push HEAD and an optional tag to main or backup remotes.

💻Interactive Review

Open editable artifacts or request confirmation for discovered destinations.

🔄Workflow Finalization

Invoke experimental finalization in the Full profile.

---

🛡️Dry-run is the starting point

Use custy --dry-run run PROFILE before normal execution. Dry-run replaces normal mutations in supported stages, but validation, discovery, local reads, and remote resolution can still occur.

---

Normal-Execution Checklist

📌Before You Begin

• Inspect repository stateRequired

  Check Git status, the current branch, local tags, and configured remotes.

• Review resolved stagesRequired

  Read the selected profile's exact registered stage list.

• Confirm project pathsRequired

  Verify commit-message, tag-message, and version-file paths.

• Read destinations and promptsRequired

  Confirm every resolved remote and interactive decision.

• Verify the final resultRequired

  Review the diff, commit, tag, and remote state before continuing.