esp.bitbucket.bitbucket_branch_info (1.4.1) — module

Install collection

Install with ansible-galaxy collection install esp.bitbucket:==1.4.1

Add to requirements.yml

  collections:
    - name: esp.bitbucket
      version: 1.4.1

Description

Retrieve branches information from Bitbucket Server for the supplied project and repository.

Authentication can be done with I(token) or with I(username) and I(password).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve all branches
  esp.bitbucket.bitbucket_branch_info:
    url: 'https://bitbucket.example.com'
    username: jsmith
    password: secrect
    repository: bar
    project_key: FOO
    validate_certs: no

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve the branches matching the supplied branch filters
  esp.bitbucket.bitbucket_branch_info:
    url: 'https://bitbucket.example.com'
    token: 'MjA2M...hqP58'
    repository: bar
    project_key: FOO
    branch: [ develop, feature ]
    validate_certs: no

Inputs

    
url:
    description:
    - Bitbucket Server URL.
    required: false
    type: str

sleep:
    default: 5
    description:
    - Number of seconds to sleep between API retries.
    type: int

token:
    description:
    - Token parameter for authentication.
    - This is only needed when not using I(username) and I(password).
    required: false
    type: str

branch:
    default:
    - '*'
    description:
    - Retrieve the branches matching the supplied I(branch) filter.
    - This can be '*' which means all branches.
    required: false
    type: list

retries:
    default: 3
    description:
    - Number of retries to call Bitbucket API URL before failure.
    type: int

password:
    description:
    - Password used for authentication.
    - This is only needed when not using I(token).
    - Required when I(username) is provided.
    required: false
    type: str

username:
    aliases:
    - user
    description:
    - Username used for authentication.
    - This is only needed when not using I(token).
    - Required when I(password) is provided.
    required: false
    type: str

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

repository:
    aliases:
    - name
    description:
    - Repository name.
    required: true
    type: str

project_key:
    aliases:
    - project
    description:
    - Bitbucket project key.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

branches:
  contains:
    displayId:
      description: Branch display ID.
      returned: success
      sample: feature/mybranch
      type: str
    id:
      description: Branch ID.
      returned: success
      sample: refs/heads/feature/mybranch
      type: str
    isDefault:
      description: Whether or not the branche is default.
      returned: success
      sample: false
      type: bool
    latestChangeset:
      description: Latest Changeset id.
      returned: success
      sample: 93b84625d75123b7f7942fd72225400fa66d62ec
      type: str
    latestCommit:
      description: Latest Commit id.
      returned: success
      sample: 93b84625d75123b7f7942fd72225400fa66d62ec
      type: str
    type:
      description: Branch type.
      returned: success
      sample: BRANCH
      type: str
  description: List of repository branches.
  returned: always
  type: list
messages:
  description: List of error messages.
  returned: always
  sample:
  - Repository `bar2` does not exist.
  type: list
project_key:
  description: Bitbucket project key.
  returned: always
  sample: FOO
  type: str
repository:
  description: Bitbucket repository name.
  returned: always
  sample: bar
  type: str