Examples

🚀Examples

Recommended

Learn how to use the validation command in common development scenarios.

Commandcusty validate

📦Category

Validation

🚀Quick Command

custy validate

---

examplesvalidationworkflow

---

Overview

The following examples demonstrate common ways to validate a project before executing Git or Custy workflows.

---

Common Examples

📝Examples

Practical command examples.

Validate the Current Project

Run all validation checks for the current project.

CLI

custy validate

---

✅Expected Result

Verifies the project repository, configuration, templates, version file, and repository state.

Validate Before a Release Workflow

Confirm that the project is ready before performing release-related operations.

CLI

custy validate

---

✅Expected Result

Reports any missing prerequisites before commit, tag, push, or release workflows begin.

---

💡Notes

This step is optional because workflow-oriented commands perform validation automatically.

---

Typical Development Workflow

📝Examples

Practical command examples.

Manual Git Workflow

Validate the project before executing Git operations manually.

CLI

git add .
custy validate
custy commit
custy tag
custy push

---

✅Expected Result

Validation confirms that the repository is ready before each Custy command executes.

Workflow-Oriented Development

Execute a complete workflow using Custy's pipeline system.

CLI

git add .
custy run release

---

✅Expected Result

The workflow automatically performs validation before continuing with the remaining stages.

---

💡Notes

Running custy validate separately is usually unnecessary when using workflow commands.

---

💡When Should I Run Validation Manually?

Running custy validate is most useful when you want to inspect your project's readiness before executing a larger workflow.

If you primarily use custy run, validation is already included as the first workflow stage.

---

Common Situations

Manual validation is especially helpful when:

• Setting up a project for the first time.
• Reviewing changes before creating a commit.
• Confirming that required configuration files exist.
• Verifying template files after running custy init.
• Diagnosing workflow failures before retrying a release.

---

What's Next?

Continue to the Output page to learn what information Custy reports after validation completes.