Overview
Validate a Project
Verify that your project satisfies the prerequisites required before executing Custy workflows.
custy validateCategory
Quick Command
custy validateOverviewâ
The validate command performs a series of pre-flight checks to verify that your project is ready for subsequent Custy operations.
Rather than modifying your repository, this command inspects your project, configuration, Git repository, and required resources to detect problems before they interrupt a larger workflow.
What This Command Does
Validation Categories
Git Repository
Project Configuration
Git State
Workflow Resources
Why Validation Matters
Running validation before a workflow helps detect common problems early.
Examples include:
- The current directory is not a Git repository.
- A required Git remote has not been configured.
- The configured version file cannot be found.
- Required template files are missing.
- No staged changes are available before a commit workflow.
- Commit message validation does not satisfy the selected strategy.
By detecting these issues first, Custy prevents incomplete or failed workflows.
When Should I Run Validation?
Validation is useful whenever you want to confirm that your project is ready before performing Git or release-related operations.
Typical situations include:
- Before creating a commit.
- Before generating a version.
- Before creating a Git tag.
- Before pushing changes.
- Before running a release workflow.
If you normally use custy run, these checks are executed automatically as part
of the workflow.