technofab/bump2version
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/bump2version.git synced 2025-12-12 16:10:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
wiseaidev 2024-03-03 13:27:20 +02:00
parent 192e9944b8
commit cf9df8cfdb
No known key found for this signature in database
GPG key ID: 581B9704F8B836C3
1 changed files with 19 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -9,6 +9,7 @@
## 📖 Table of Contents ## 📖 Table of Contents
- [Quick Start](#-quick-start) - [Quick Start](#-quick-start)
- [Configuration File](#-configuration-file)
- [Features](#-features) - [Features](#-features)
- [Options](#-options) - [Options](#-options)
- [GitHub Repository](#-github-repository) - [GitHub Repository](#-github-repository)
@ -27,9 +28,25 @@ Get started with the `bump2version` CLI by following these simple steps:
1. Use the following options to manage version numbers and customize the behavior: 1. Use the following options to manage version numbers and customize the behavior:
```bash ```bash
bump2version --current-version 1.2.3 --bump patch bump2version --bump patch # or minor or major
``` ```
## 🛠️ Configuration File
To customize the behavior of `bump2version`, you can use a configuration file named `.bumpversion.toml`. This file should be present in the root of your project. If it's not found, the cli will use default values.
Here's an example `.bumpversion.toml` configuration file you can use in your project:
```toml
[bumpversion]
current_version = "0.1.0" # Specify the current version of your project.
# Specify how to search for and replace the version in the 'Cargo.toml' file.
[bumpversion:file:Cargo.toml]
search = 'version = "{current_version}"'
replace = 'version = "{new_version}"'
```
## ✨ Features ## ✨ Features
- **Incremental Versioning:** Bump major, minor, or patch versions with ease. - **Incremental Versioning:** Bump major, minor, or patch versions with ease.
@ -40,7 +57,7 @@ Get started with the `bump2version` CLI by following these simple steps:
| Option | Description | | Option | Description |
|------------------------|-------------------------------------------------------------------| |------------------------|-------------------------------------------------------------------|
| `--config-file` | Config file to read most of the variables from. | | `--config-file` | Config file to read most of the variables from (default: `.bumpversion.toml`). |
| `--current-version` | Version that needs to be updated. | | `--current-version` | Version that needs to be updated. |
| `--bump` | Part of the version to be bumped (default: patch). | | `--bump` | Part of the version to be bumped (default: patch). |
| `--parse` | Regex parsing the version string (default: \d+\.\d+\.\d+). | | `--parse` | Regex parsing the version string (default: \d+\.\d+\.\d+). |