Skip to content

Commit

Permalink
Removes tagSelector from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdubiel committed Jul 15, 2017
1 parent 59b1017 commit eba29f2
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions docs/configuration/overview.rst
Expand Up @@ -11,26 +11,24 @@ All ``axion-release-plugin`` configuration options:
type = 'git' // type of repository
directory = project.rootProject.file('./') // repository location
remote = 'origin' // remote name
// :doc:`authorization`
customKey = 'AAasaDDSSD...' or project.file('myKey') // custom authorization key (file or String)
customKeyPassword = 'secret' // key password
tagSelector = { tags -> ... } // choose tag to process when multiple on commit
}
// :doc:`dry_run`
localOnly = false // never connect to remote
// :doc:`uncommitted_changes`
ignoreUncommittedChanges = true // should uncommitted changes force version bump
// :doc`use_highest_version`
useHighestVersion = false // Defaults as false, setting to true will find the highest visible version in the commit tree
// :ref:`version-sanitization`
sanitizeVersion = true // should created version be sanitized, true by default
tag { // :ref:`version-parsing`
prefix = 'tag-prefix' // prefix to be used, 'release' by default
branchPrefix = [ // set different prefix per branch
Expand All @@ -42,7 +40,7 @@ All ``axion-release-plugin`` configuration options:
deserialize = { tag, position, tagName -> ... } // reads raw version from tag
initialVersion = { tag, position -> ... } // returns initial version if none found, 0.1.0 by default
}
nextVersion { // :doc:`next_version`
suffix = 'alpha' // tag suffix
separator = '-' // separator between version and suffix
Expand All @@ -67,7 +65,7 @@ All ``axion-release-plugin`` configuration options:
// :doc:`hooks`
createReleaseCommit true // should create empty commit to annotate release in commit history, false by default
releaseCommitMessage { version, position -> ... } // custom commit message if commits are created
// :doc:`checks`
checks {
uncommittedChanges = false // permanently disable uncommitted changes check
Expand Down

0 comments on commit eba29f2

Please sign in to comment.