Version Bumper config

Configuration for Version Bumper, a Composer plugin to bump project versions during release preparations

Type object
File match version-bumper.json version-bumper.yaml version-bumper.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/version-bumper-config/latest.json
Source https://raw.githubusercontent.com/eliashaeussler/version-bumper/refs/heads/main/res/version-bumper.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

presets preset | presetShort[]
filesToModify fileToModify[]
releaseOptions object
4 nested properties
commitMessage string

May contain a {%version%} placeholder that is replaced by the version to release.

overwriteExistingTag boolean

If set to true, the existing tag will be deleted before the new tag is created.

signTag boolean

Uses Git's -s command option to sign the new tag using the Git-configured signing key.

tagName string
pattern=\{%version%\}
rootPath string

This path will be used to calculate paths to configured files if they are configured as relative paths. If the root path is configured as relative path, it is calculated based on the config file path.

versionRangeIndicators versionRangeIndicator[]

Definitions

fileToModify object
path string required

Relative paths are calculated from the configured (or calculated) project root.

patterns versionPattern[] required

Each pattern must contain a {%version%} placeholder that is replaced by the new version. Patterns are internally converted to regular expressions, so feel free to use regex syntax such as \s+.

reportUnmatched boolean
Default: false
reportMissing boolean
Default: true
preset object
presetShort string

Configuration for presets which do not have required preset options

releaseOptions object
commitMessage string

May contain a {%version%} placeholder that is replaced by the version to release.

overwriteExistingTag boolean

If set to true, the existing tag will be deleted before the new tag is created.

signTag boolean

Uses Git's -s command option to sign the new tag using the Git-configured signing key.

tagName string
pattern=\{%version%\}
versionPattern string
versionRange string
versionRangeIndicator object
patterns versionRangePattern[] required
range string required
Values: "major" "minor" "next" "patch"
strategy string
Default: "matchAny"
Values: "matchAll" "matchAny" "matchNone"
versionRangePattern object
pattern string required
type string required
Values: "commitMessage" "fileAdded" "fileDeleted" "fileModified"