versioner

README

Versioner

Application version is usually stored in project files, such as pom.xml, package.json etc.

Sometimes there are more than 1 file that store the same version.

This tool helps to manage version and cut a release in such cases.

Usage

Operations

versioner bump major

• Changes 1.2.3-SNAPSHOT to 2.0.0
• Changes 1.2.3 to 2.0.0

---

versioner bump minor

• Changes 1.2.3-SNAPSHOT to 1.3.0
• Changes 1.2.3 to 1.3.0

---

versioner bump patch

• Changes 1.2.3-SNAPSHOT to 1.2.4
• Changes 1.2.3 to 1.2.4

---

versioner release

• Changes 1.2.3-SNAPSHOT to 1.2.3
• Changes 1.2.3 to 1.2.3

---

versioner snapshot

• Changes 1.2.3-SNAPSHOT to 1.2.3-SNAPSHOT
• Changes 1.2.3 to 1.2.3-SNAPSHOT

---

versioner get

versioner get patch

• For 1.2.3-SNAPSHOT prints 1.2.3-SNAPSHOT

---

versioner get --release

• For 1.2.3-SNAPSHOT prints 1.2.3

---

versioner get minor --release

• For 1.2.3-SNAPSHOT prints 1.2

---

versioner get major --release

• For 1.2.3-SNAPSHOT prints 1

---

Configuration

In order for versioner to know which files contain a version, a configuration file should be created.

The configuration file is a versioner.yaml file by default which is taken from a current directory

files:
    - name: helm/*.yaml
      path: $.app.version
    - name: pom.xml
      path: $.project.version
    - name: package.json
      path: $.version
    - name: custom.properties
      regexp: "(?s).*app\.version=(.+)"
debug: false

When it needs to read a version, the first file will be used. When it needs to write a version, every file will be updated.

Two modes are supported: structured path and regexp for free form files.

The path format looks simlar to JsonPath:

• starts with root element - $
• node levels are separated with .
• supports json, yaml, xml based on file extension

The regexp format is helpful for unstructured text files.