ripclawffb.helix_core.helix_core_stream (1.0.4) — module

Install collection

Install with ansible-galaxy collection install ripclawffb.helix_core:==1.0.4

Add to requirements.yml

  collections:
    - name: ripclawffb.helix_core
      version: 1.0.4

Description

Create or edit an instance of a stream (also known as a stream definition).

This module supports check mode.

Requirements

• P4Python pip module is required. Tested with 2018.2.1743033

Usage examples

Scanned by Steampunk Spotter

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

# Create a stream
- name: Create a new stream
  helix_core_stream:
    state: present
    stream: //depotname/streamname
    description: 'Development Stream'
    type: development
    paths:
      - share ...
    server: '1666'
    user: bruno
    charset: none
    password: ''

Scanned by Steampunk Spotter

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

# Delete a stream
- name: Delete a stream
  helix_core_stream:
    state: absent
    name: //depotname/streamname
    server: '1666'
    user: bruno
    charset: none
    password: ''

Inputs

    
name:
    description:
    - Display name of the stream
    type: str

type:
    choices:
    - mainline
    - development
    - release
    - virtual
    - task
    default: development
    description:
    - "The stream\u2019s type determines the expected flow of change. Valid stream types\
      \ are mainline, development, release, virtual, andtask."
    type: str

user:
    aliases:
    - p4user
    description:
    - A user with access to create streams
    - Can also use 'P4USER' environment variable
    required: true
    type: str

owner:
    description:
    - The Helix server user or group who owns the stream
    type: str

paths:
    default:
    - share ...
    description:
    - Paths define how files are incorporated into the stream structure
    elements: str
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines if the stream is present or deleted
    type: str

parent:
    default: none
    description:
    - The parent of this stream
    type: str

server:
    aliases:
    - p4port
    description:
    - The hostname/ip and port of the server (perforce:1666)
    - Can also use 'P4PORT' environment variable
    required: true
    type: str

stream:
    description:
    - "Specifies the stream\u2019s name (permanent identifier) and its path in the stream\
      \ depot, in the form //depotname/streamname"
    required: true
    type: str

charset:
    aliases:
    - p4charset
    default: none
    description:
    - Character set used for translation of unicode files
    - Can also use 'P4CHARSET' environment variable
    required: false
    type: str

ignored:
    description:
    - A list of file or directory names to be ignored
    elements: str
    type: list

options:
    default: allsubmit unlocked toparent fromparent mergedown
    description:
    - Settings that configure stream behavior
    type: str

password:
    aliases:
    - p4passwd
    description:
    - The user password
    - Can also use 'P4PASSWD' environment variable
    required: true
    type: str

remapped:
    description:
    - Reassigns the location of workspace files
    elements: str
    type: list

parentview:
    default: inherit
    description:
    - Defines whether the stream inherits a view from its parent
    type: str

description:
    default: Created by user.
    description:
    - Description of the stream
    type: str

See also

• Helix Core Stream: Create or edit an instance of a stream (also known as a stream definition). link
• P4Python Pip Module: Python module to interact with Helix Core link