https://github.com/meyt/verbump

Easy version incrementing CLI tool
https://github.com/meyt/verbump

Last synced: about 1 month ago
JSON representation

Easy version incrementing CLI tool

• Host: GitHub
• URL: https://github.com/meyt/verbump
• Owner: meyt
• Created: 2022-09-01T08:43:59.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-09-03T16:38:55.000Z (about 2 years ago)
• Last Synced: 2024-09-13T13:09:32.562Z (2 months ago)
• Language: Python
• Size: 7.81 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# verbump

[![pypi](https://img.shields.io/pypi/pyversions/verbump.svg)](https://pypi.python.org/pypi/verbump)

Easy version incrementing CLI tool.

* Automatic relative version bump

* Automatic `git commit` and `git tag`

* Regex based version pattern

* Using `semver` style

## Installation

```bash

pip install verbump

```

## Usage

1. Create the configuration file `.verbump.ini` inside your project's root directory.

2. Run `verbump`

```bash

verbump [major|minor|patch|build]

```

### Relative bump

```bash

verbump minor

```

## Configuration

Available keys for `.verdump.ini` :

* `pattern`: {string} Version pattern regex (required)

* `commit`: {boolean} Enables git auto-commit

* `tag`: {boolean} Enables git auto-tag

* `commit_format`: {string} Auto-commit message format. default is `v%s`

* `tag_format`: {string} Auto-tag name format. default is `v%s`

## Configuration samples

### Generic `VERSION` file:

```ini

[file:VERSION]

pattern = (\d+.\d+.\d+(?:.\d+)?)*

```

### Generic `VERSION` file, git auto-commit & auto-tag enabled:

```ini

[file:VERSION]

commit = true

tag = true

pattern = (\d+.\d+.\d+(?:.\d+)?)*

```

### Nodejs `package.json` :

```ini

[file:package.json]

pattern = "version"\s*:\s*"(\d+.\d+.\d+(?:.\d+)?)"\s*,

```

### Python `__version__` style:

```ini

[file:mymodule/__init__.py]

pattern = __version__\s*=\s*(?:"|')(\d+.\d+.\d+(?:.\d+)?)(?:"|')

```