W3cubDocs

/Ansible

community.general.bzr module – Deploy software (or files) from bzr branches

Note

This module is part of the community.general collection (version 10.7.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.bzr.

Synopsis
Parameters
Attributes
Examples

Synopsis

Manage bzr branches to deploy files or software.

Parameters

Parameter	Comments
dest path / required	Absolute path of where the branch should be cloned to.
executable string	Path to bzr executable to use. If not supplied, the normal mechanism for resolving binary paths will be used.
force boolean	If `true`, any modified files in the working tree will be discarded. Choices: `false` ← (default) `true`
name aliases: parent string / required	SSH or HTTP protocol address of the parent branch.
version string	What version of the branch to clone. This can be the bzr revno or revid. Default: `"head"`

Attributes

Attribute	Support	Description
check_mode	Support: none	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

Examples

- name: Checkout
  community.general.bzr:
    name: bzr+ssh://foosball.example.org/path/to/branch
    dest: /srv/checkout
    version: 22

Authors

André Paramés (@andreparames)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/bzr_module.html