Examples

🚀Examples

Stable

Learn how to synchronize project versions using common Version Update scenarios.

Commandcusty version

📦Category

Versioning

🚀Quick Command

custy version update

---

examplesversion

---

Overview

The following examples demonstrate common ways to synchronize version information across supported project files.

Each example focuses on a single concept so that individual options can be combined as needed.

---

Basic Examples

📝Examples

Practical command examples.

Synchronize Project Version

Update project version files using the configured defaults.

CLI

custy version update

---

✅Expected Result

Custy generates the next version and synchronizes every supported project version file.

---

Selecting a Version Strategy

📝Examples

Practical command examples.

Use Semantic Versioning

Generate the next version using the SemVer strategy.

CLI

custy version update --strategy semver

---

✅Expected Result

The next version is calculated according to Semantic Versioning.

Use PEP 440

Generate the next version using the Python PEP 440 strategy.

CLI

custy version update --strategy pep440

---

✅Expected Result

Custy generates a PEP 440 compliant version before synchronizing project files.

---

Version Generation

📝Examples

Practical command examples.

Minor Release

Generate the next minor version.

CLI

custy version update --bump minor

---

✅Expected Result

The generated version increments the minor component according to the selected strategy.

Explicit Version

Synchronize project files using a specific version.

CLI

custy version update --tag v2.5.0

---

✅Expected Result

The supplied version is synchronized without generating a new one.

---

Pre-release Examples

📝Examples

Practical command examples.

Beta Release

Generate a beta pre-release.

CLI

custy version update --pre-release beta

---

✅Expected Result

Custy generates the next beta version supported by the selected strategy.

Development Release

Generate a development release.

CLI

custy version update --dev-release

---

✅Expected Result

Development version information is applied where supported.

---

Global Options

📝Examples

Practical command examples.

Preview Version Update

Review version synchronization without modifying project files.

CLI

custy --dry-run version update

---

✅Expected Result

Displays the actions that would be performed without updating any files.

Debug Version Update

Display additional diagnostic information.

CLI

custy --debug version update

---

✅Expected Result

Runs Version Update while producing detailed debug output.

---

💡One Strategy per Execution

Although Custy supports multiple versioning strategies, a single Version Update execution uses only one strategy to determine the version before synchronizing project files.

---

What's Next?

Continue to the Output page to learn how Custy reports successful version synchronization.