info.yml

# Copyright (c) 2013 Shotgun Software Inc.
# 
# CONFIDENTIAL AND PROPRIETARY
# 
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit 
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your 
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights 
# not expressly granted therein are reserved by Shotgun Software Inc.

# Metadata defining the behaviour and requirements for this framework

# expected fields in the configuration file for this engine
configuration:

    server:
        type: str
        description: "Perforce server to connect to.  Should be of the form: 'protocol:server:port'. 
                     e.g. 'tcp:perforce:1666'"
        
    server_aliases:
        type: list
        values:
            type: str
        allows_empty: True
        default_value: []
        description: "A list of aliases for the Perforce server - if the Perforce server is moved or
                      given a new protocol, name or port, adding the original to this list will allow
                      Toolkit to continue using publishes that were published to the old server.  The
                      current server should always be specified in the 'server' setting."

    host:
        type: str
        description: "Name of the host computer to impersonate when connecting to Perforce.  
                      This is usually left empty!"
        default_value: ''
        
    hook_get_perforce_user:
        type: hook
        parameters: [sg_user]
        default_value: get_perforce_user
        description: "Specify a hook that will return the Perforce user name for a specified Shotgun
                      user name"

    hook_get_shotgun_user:
        type: hook
        parameters: [p4_user]
        default_value: get_shotgun_user
        description: "Specify a hook that will return the Shotgun user name for a specified Perforce
                      user name"
        
    hook_store_publish_data:
        type: hook
        parameters: [local_path, publish_data, p4]
        default_value: store_publish_data
        description: ''

    hook_load_publish_data:
        type: hook
        parameters: [depot_path, user, workspace, revision, p4]
        default_value: load_publish_data
        description: ''
        
    hook_store_review_data:
        type: hook
        parameters: [local_publish_paths, version_data, p4]
        default_value: store_review_data
        description: ''
        
    hook_load_review_data:
        type: hook
        parameters: [depot_path, user, workspace, revision, p4]
        default_value: load_review_data
        description: ''

# This framework is shared so that there is only a single instance
shared: True

# the Shotgun fields that this engine needs in order to operate correctly
requires_shotgun_fields:

# More verbose description of this item 
display_name: "Perforce Framework"
description: "Common Perforce functionality used by various apps & hooks"

# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.14.61"