Versioce.Config (Versioce v0.2.1) View Source
Configuration module for versioce app. Picks either a value from config.ex or a default.
All config values take either a direct value or a function of arity 0 that will return the value.
Link to this section Summary
Functions
Get config value for commit_message_template
Get config value for dirty_add
Get config value for files
Get config value for global
Get config value for post_hooks
Get config value for pre_hooks
Get config value for tag_message_template
Get config value for tag_template
Link to this section Functions
Get config value for commit_message_template
Template for the commit message. {version}
will be replaced with the version you bumped to
You can configure it with:
config :versioce, :git,
commit_message_template: "Bump version to {version}"
Value for this configuration should either be a literal value or a function of 0 arity, that will return the value, ex:
config :versioce, :git,
commit_message_template: fn -> "Bump version to {version}" end
Get config value for dirty_add
Whether to add all the files in git add
or only from Versioce.Config.files
. By default only Versioce.Config.files
You can configure it with:
config :versioce, :git,
dirty_add: false
Value for this configuration should either be a literal value or a function of 0 arity, that will return the value, ex:
config :versioce, :git,
dirty_add: fn -> false end
Get config value for files
Files to be updated with new version
You can configure it with:
config :versioce,
files: ["README.md"]
Value for this configuration should either be a literal value or a function of 0 arity, that will return the value, ex:
config :versioce,
files: fn -> ["README.md"] end
Get config value for global
Whether the update will be global in file. By default versioce will update only the first version in file it finds
You can configure it with:
config :versioce,
global: false
Value for this configuration should either be a literal value or a function of 0 arity, that will return the value, ex:
config :versioce,
global: fn -> false end
Get config value for post_hooks
Hooks to run after the version bumping
You can configure it with:
config :versioce,
post_hooks: []
Value for this configuration should either be a literal value or a function of 0 arity, that will return the value, ex:
config :versioce,
post_hooks: fn -> [] end
Get config value for pre_hooks
Hooks to run before the version bumping
You can configure it with:
config :versioce,
pre_hooks: []
Value for this configuration should either be a literal value or a function of 0 arity, that will return the value, ex:
config :versioce,
pre_hooks: fn -> [] end
Get config value for tag_message_template
Template for the tag message. {version}
will be replaced with the version you bumped to
You can configure it with:
config :versioce, :git,
tag_message_template: "Release version to {version}"
Value for this configuration should either be a literal value or a function of 0 arity, that will return the value, ex:
config :versioce, :git,
tag_message_template: fn -> "Release version to {version}" end
Get config value for tag_template
Template for the tag annotation. {version}
will be replaced with the version you bumped to
You can configure it with:
config :versioce, :git,
tag_template: "{version}"
Value for this configuration should either be a literal value or a function of 0 arity, that will return the value, ex:
config :versioce, :git,
tag_template: fn -> "{version}" end