Reference

levels

Levels

leveldescription
majorCreates major release version.I.e. from 1.2.3 to 2.2.3
minorCreates minor release version.I.e. from 1.2.3 to 1.3.3
patchCreates patch release version.I.e. from 1.2.3 to 1.2.4
rcCreates release candidate version.I.e. from 1.2.3 to 1.2.4-rc.0
betaCreates beta release version.I.e. from 1.2.3 to 1.2.4-beta.0
alphaCreates alpha release version.I.e. from 1.2.3 to 1.2.4-alpha.0

settings

Settings

FieldArgumentTypeDescription
--d, --dry-runBooleanPreview all operations that will be executed.
tag_prefix--tag-prefixStringTag prefix usually just v (short for version). Will be created from version. I.e. if version is 1.2.3 and tag prefix is "ver" resulting tag will be ver1.2.3
hex_publish-h, --skip-publishBooleanDisabled by default. Enable publishing to hex.pm Should authorize beforehand. Check Publishing a package article.
git_push-g, --skip-pushBooleanEnabled by default. Enable git push at the end of all operations
dev_version-v, --skip_dev_versionBooleanWill not bump version after release. Enabled by default
changelog-ConfigConfiguration for changelog. Check Changelog section
merge-ConfigConfiguration for merging. Check Merge section
--m, --skip_mergeBooleanWill skip merge if configures (NOT RELEASED)
commit_message-StringOverwrite for commit message. Replacement values are {{version}}

changelog-config

Changelog config

NameTypeDescription
creationAtomMode of creation.

creation-settings

Creation settings

OptionDescription
disabledChangelog will not be created
manualChangelog will updated accordingly to replacements settings. Replacement values are {{version}}, {{date}}, {{tag_name}}. Everything that actually has changed should be written directly to changelog file
git_logs!Not implemented! Same as manual, but additionally if git commit massage starts with add!, change!, fix!, message will be added to changelog.

replacements-config

Replacements config

NameTypeDescription
fileStringFile name in which to do replacements.
patternsConfig[]List of pattern settings. Check Patterns config section

patterns-config

Patterns config

NameTypeDescription
searchString/RegExPattern to search in specified file
replaceStringString which will replace what is found. ({{version}}, {{date}}, {{tag_name}} Will be replaced accordingly)
globalBooleanFile name in which to do replacements.

merge

Merge

NameTypeDescription
branchesMapping listMap of branch names to merge from and to. I.E. %{from: "master", to: ["develop", "edge"]}
ignore_conflictsBooleanWill only warn on merge conflicts and will proceed by skipping branch with conflicts. Default false