Skip to content

fdaciuk/cargo-v

Repository files navigation

Welcome to cargo-v 👋

All Contributors

Documentation License: MIT Twitter: fdaciuk

An easy way to update the version of your package

Install

cargo install cargo-v

This CLI is intended to update the version of your package using the SemVer.

Important note

Before using this CLI, make sure you:

  • run the cargo build command to ensure your package doesn't have any errors;
  • have committed all important files (including Cargo.toml and Cargo.lock, that will be "git added" automatically by the CLI);

Usage

You can update the version of your project using the command:

cargo v <version>

Where <version> can be one of patch, minor, major or a complete string version like v1.1.0 or just 1.1.0.

You can use <version> just as a partial string version like 2 or 2.1, that is the same as v2.0.0 and v2.1.0 respectively.

The above command will do:

  • update the string version of your package from Cargo.toml;
  • update the string version of your package from Cargo.lock;
  • create a git commit with new version;
  • and create a git tag with new version.

Before do a git commit and git tag, you will be asked if everything is ok with your project. To automatically answer yes to all questions, just use the flag -y or --yes:

cargo v <version> -y

To see all possible options, just run cargo v --help.

Author

👤 Fernando Daciuk

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

✨ Contributors

Thanks goes to these wonderful people (emoji key):


Fernando Daciuk

💻 📖

Matheus Henrique

💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Fernando Daciuk.

This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator