@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/create/create-branch/CreateBranch.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGSession = require('../../../sessions/EBGSession.js');
var EndevorSession = require('../../../sessions/EndevorSession.js');
var BranchOptions = require('../../../options/BranchOptions.js');

/*
 * Copyright (c) 2019 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 */
const CreateBranchDefinition = {
    name: "branch",
    aliases: ["br"],
    type: "command",
    handler: __dirname + "/CreateBranch.handler",
    description: "Add a branch to an existing mapping",
    positionals: [
        BranchOptions.BranchOptions.CONTEXT,
        BranchOptions.BranchOptions.MAPPING,
        BranchOptions.BranchOptions.BRANCH_ID,
    ],
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE, EndevorSession.EndevorSession.PROFILE_TYPE],
    },
    options: [
        BranchOptions.BranchOptions.ENDEVOR_SYSTEM,
        BranchOptions.BranchOptions.ENDEVOR_SUBSYSTEM,
        BranchOptions.BranchOptions.ENDEVOR_SYSTEM_ALIAS,
        BranchOptions.BranchOptions.ENDEVOR_SUBSYSTEM_ALIAS,
        BranchOptions.BranchOptions.ENDEVOR_ENVIRONMENT,
        BranchOptions.BranchOptions.READ_ONLY,
        BranchOptions.BranchOptions.ENDEVOR_STAGE_NUMBER,
        BranchOptions.BranchOptions.MAPPING_MODE,
        BranchOptions.BranchOptions.LIKE_BRANCH,
        BranchOptions.BranchOptions.REPOSITORY_CHECK,
    ].concat(EndevorSession.EndevorSession.ENDEVOR_CONNECTION_OPTIONS),
    examples: [
        {
            description: "Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile",
            options: "MY-CONTEXT MY-MAPPING MY-BRANCH --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME",
        },
        {
            description: "Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile " +
                "by using another branch as a template with different environment",
            options: "MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-environment DIFFERENT_ENVIRONMENT",
        },
        {
            description: "Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile " +
                "by using another branch as a template with different system/subsystem",
            options: "MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-system DIFFERENT_SYSTEM --endevor-subsystem DIFFERENT_SUBSYSTEM",
        },
    ],
};

exports.CreateBranchDefinition = CreateBranchDefinition;