https://github.com/fdaciuk/cargo-v

Update the version of your package easily
https://github.com/fdaciuk/cargo-v

cli semantic semver version versioning

Last synced: 16 days ago
JSON representation

Update the version of your package easily

• Host: GitHub
• URL: https://github.com/fdaciuk/cargo-v
• Owner: fdaciuk
• Created: 2022-05-23T11:38:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-25T00:51:36.000Z (over 2 years ago)
• Last Synced: 2024-10-13T13:30:08.788Z (about 1 month ago)
• Topics: cli, semantic, semver, version, versioning
• Language: Rust
• Homepage: https://crates.io/crates/cargo-v
• Size: 59.6 KB
• Stars: 13
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Welcome to cargo-v 👋

[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#-contributors)

[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/fdaciuk/cargo-v#readme)

![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)

[![Twitter: fdaciuk](https://img.shields.io/twitter/follow/fdaciuk.svg?style=social)](https://twitter.com/fdaciuk)

> An easy way to update the version of your package

### 🏠 [Homepage](https://github.com/fdaciuk/cargo-v)

## Install

```sh

cargo install cargo-v

```

This CLI is intended to update the version of your package using the [SemVer](https://semver.org).

## 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:

```sh

cargo v 

```

Where `` can be one of `patch`, `minor`, `major` or a complete string 

version like `v1.1.0` or just `1.1.0`. 

You can use `` 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`:

```sh

cargo v  -y

```

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

## Author

👤 **Fernando Daciuk**

* Website: https://daciuk.dev

* Twitter: [@fdaciuk](https://twitter.com/fdaciuk)

* Github: [@fdaciuk](https://github.com/fdaciuk)

* LinkedIn: [@fdaciuk](https://linkedin.com/in/fdaciuk)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check [issues page](https://github.com/fdaciuk/cargo-v/issues). 

## ✨ Contributors 

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Fernando Daciuk
💻 📖

    
Matheus Henrique
💻 📖

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2022 [Fernando Daciuk](https://github.com/fdaciuk).

This project is **MIT** licensed.

***

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_