community.general.bitbucket_pipeline_variable (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Manages Bitbucket pipeline variables.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create or update pipeline variables from the list
  community.general.bitbucket_pipeline_variable:
    repository: 'bitbucket-repo'
    workspace: bitbucket_workspace
    name: '{{ item.name }}'
    value: '{{ item.value }}'
    secured: '{{ item.secured }}'
    state: present
  with_items:
    - { name: AWS_ACCESS_KEY, value: ABCD1234, secured: false }
    - { name: AWS_SECRET, value: qwe789poi123vbn0, secured: true }

Scanned by Steampunk Spotter

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

- name: Remove pipeline variable
  community.general.bitbucket_pipeline_variable:
    repository: bitbucket-repo
    workspace: bitbucket_workspace
    name: AWS_ACCESS_KEY
    state: absent

Inputs

    
name:
    description:
    - The pipeline variable name.
    required: true
    type: str

user:
    aliases:
    - username
    description:
    - The username.
    - If not set the environment variable E(BITBUCKET_USERNAME) will be used.
    - O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was
      an alias of O(workspace) before.
    type: str
    version_added: 4.0.0
    version_added_collection: community.general

state:
    choices:
    - absent
    - present
    description:
    - Indicates desired state of the variable.
    required: true
    type: str

value:
    description:
    - The pipeline variable value.
    type: str

secured:
    default: false
    description:
    - Whether to encrypt the variable value.
    type: bool

password:
    description:
    - The App password.
    - If not set the environment variable E(BITBUCKET_PASSWORD) will be used.
    type: str
    version_added: 4.0.0
    version_added_collection: community.general

client_id:
    description:
    - The OAuth consumer key.
    - If not set the environment variable E(BITBUCKET_CLIENT_ID) will be used.
    type: str

workspace:
    description:
    - The repository owner.
    - B(Note:) O(ignore:username) used to be an alias of this option. Since community.general
      6.0.0 it is an alias of O(user).
    required: true
    type: str

repository:
    description:
    - The repository name.
    required: true
    type: str

client_secret:
    description:
    - The OAuth consumer secret.
    - If not set the environment variable E(BITBUCKET_CLIENT_SECRET) will be used.
    type: str