Docs4dev
Docs
ansible / 2.4 / subversion_module.html

subversion - Deploys a subversion repository.

Synopsis

  • Deploy given repository URL / revision to dest. If dest exists, update to the specified revision, otherwise perform a checkout.

Options

parameter required default choices comments
checkout
(added in 2.3)
no yes
  • yes
  • no
If no, do not check out the repository if it does not exist locally
dest
 yes
Absolute path where the repository should be deployed.
executable
(added in 1.4)
no
Path to svn executable to use. If not supplied, the normal mechanism for resolving binary paths will be used.
export
(added in 1.6)
no no
  • yes
  • no
If yes, do export instead of checkout/update.
force
 no no
  • yes
  • no
If yes, modified files will be discarded. If no, module will fail if it encounters modified files. Prior to 1.9 the default was `yes`.
password
 no
--password parameter passed to svn.
repo
 yes
The subversion URL to the repository.
aliases: name, repository
revision
 no HEAD
Specific revision to checkout.
aliases: version
switch
(added in 2.0)
no yes
  • yes
  • no
If no, do not call svn switch before update.
update
(added in 2.3)
no yes
  • yes
  • no
If no, do not retrieve new revisions from the origin repository
username
 no
--username parameter passed to svn.

Examples

# Checkout subversion repository to specified folder.
- subversion:
    repo: svn+ssh://an.example.org/path/to/repo
    dest: /src/checkout

# Export subversion directory to folder
- subversion:
    repo: svn+ssh://an.example.org/path/to/repo
    dest: /src/export

# Example just get information about the repository whether or not it has
# already been cloned locally.
- subversion:
    repo: svn+ssh://an.example.org/path/to/repo
    dest: /srv/checkout
    checkout: no
    update: no

Notes

Note

  • Requires svn to be installed on the client.
  • This module does not handle externals

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/subversion_module.html