esp.bitbucket.bitbucket_pull_request_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

Get information about pull requests on Bitbucket Server.

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: Get information about pull requests
  esp.bitbucket.bitbucket_pull_request_info:
    url: 'https://bitbucket.example.com'
    username: jsmith
    password: secrect
    repository: bar
    project_key: FOO
    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

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:
    description:
    - Repository name.
    required: true
    type: str

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

return_content:
    default: true
    description:
    - Whether or not to return the body of the response as a "content" key in the dictionary
      result no matter it succeeded or failed.
    type: bool

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

json:
  contains:
    author:
      description: Pull request author.
      returned: success
      sample: john
      type: str
    fromRef:
      description: From branch name.
      returned: success
      sample: develop
      type: str
    id:
      description: Pull request id.
      returned: success
      sample: 2
      type: int
    reviewers:
      description: List of reviewers.
      elements: str
      returned: success
      sample:
      - joe
      - jsmith
      type: list
    title:
      description: Pull request title.
      returned: success
      sample: baz.yml edited online with Bitbucket
      type: str
    toRef:
      description: To branch name.
      returned: success
      sample: master
      type: str
    version:
      description: Pull request version.
      returned: success
      sample: 0
      type: int
  description: List of pull requests for the supplied project and repository.
  elements: dict
  returned: success
  type: list
messages:
  description: List of error messages.
  returned: always
  sample:
  - Project `FOOO` does not exist.
  type: list
project_key:
  description: Bitbucket project key.
  returned: success
  sample: FOO
  type: str
repository:
  description: Bitbucket repository name.
  returned: success
  sample: bar
  type: str