Generate a full Package.xml using the Salesforce CLI

GenerateFullPackageXML.sh

#!/bin/sh
#
# Generate a full package xml using the Salesforce CLI

# Requirements :
#   * Salesforce CLI
#   * jq


# Mapping metadata type folder for the inFolder=true metadata types
declare -A inFolderMetadataMapping
inFolderMetadataMapping["Report"]="ReportFolder";
inFolderMetadataMapping["Dashboard"]="DashboardFolder"
inFolderMetadataMapping["Document"]="DocumentFolder"
inFolderMetadataMapping["EmailTemplate"]="EmailFolder"


#######################################
# Generate XML for a metadata type name
# Arguments:
#   metadata type name
# Returns:
#   xml
#######################################
function generateNameXML(){
    local name=$1
    echo "<name>${name}</name>"
}

#######################################
# Generate XML for a metadata name
# Arguments:
#   metadata name
# Returns:
#   xml
#######################################
function generateMemberXML(){
    local member=$1
    echo "<members>${member}</members>"
}

#######################################
# Convert JSON list metadata to a list
# Arguments:
#   list metadata names in JSON format
# Returns:
#   list of metadata names
#######################################
function convertListMetadata(){
    local listMetadataJSON=$1

    if [ "${listMetadataJSON}" != "null" ]; then

        isArray=$(echo ${listMetadataJSON} | jq 'if type=="array" then 1 else 0 end')

        if [ "$isArray" == "1" ]; then
            listMetadataNames="$(echo ${listMetadataJSON} | jq -r '.[] | .fullName' | tr -d '\n' | tr '\r' ':')"
        else 
            listMetadataNames="$(echo ${listMetadataJSON} | jq -r '.fullName' | tr -d '\n' | tr '\r' ':')"
        fi

        echo ${listMetadataNames}
    fi

}

#######################################
# List metadata names for a metadata type
# Arguments:
#   api version
#   metadata type name
#   metadata type in folder flag
# Returns:
#   list of metadata names
#######################################
function listMetadataNames(){
    local apiVersion=$1
    local metadataTypeName=$2
    local metadataTypeInFolder=$3

    ## metadata type in folder
    if [ "${metadataTypeInFolder}" == "true" ]; then
        # list folders
        local listMetadataFolderResult=$(echo $(sfdx force:mdapi:listmetadata -a ${apiVersion} -m ${inFolderMetadataMapping[${metadataTypeName}]} --json) | jq '.result')
        local listMetadataFolders=$(convertListMetadata "${listMetadataFolderResult}")
        local listMetadataAllFolderItems=""
        # loop through folders
        IFS=":" read -ra listMetadataFoldersArray <<< "${listMetadataFolders}"
        for folder in ${listMetadataFoldersArray[@]}; do 
            # list folder items
            local listMetadataFolderItemResult=$(echo $(sfdx force:mdapi:listmetadata -a ${apiVersion} -m ${metadataTypeName} --folder ${folder} --json) | jq '.result')
            local listMetadataFolderItems="$(convertListMetadata "${listMetadataFolderItemResult}")"
            if [ "${listMetadataFolderItems}" != "" ]; then
                listMetadataAllFolderItems="${listMetadataAllFolderItems}${listMetadataFolderItems}"
            fi
        done
        local listMetadata="${listMetadataFolders}${listMetadataAllFolderItems}"
        echo "${listMetadata::-1}"
    else 
        local listMetadataResult=$(echo $(sfdx force:mdapi:listmetadata -a ${apiVersion} -m ${metadataTypeName} --json) | jq '.result')
        echo "$(convertListMetadata "${listMetadataResult}")"
    fi
    
}

#######################################
# Generate XML for a metadata type
# Arguments:
#   api version
#   metadata type name
#   metadata type in folder flag
# Returns:
#   xml
#######################################
function generateTypeXML(){
    local apiVersion=$1
    local metadataTypeName=$2
    local metadataTypeInFolder=$3

    local listMetadataNames="$(listMetadataNames ${apiVersion} ${metadataTypeName} ${metadataTypeInFolder})"

    if [ "${listMetadataNames}" != "" ]; then
        echo "  <types>"
        IFS=":"
        for metadataName in ${listMetadataNames}; do 
            echo "      $(generateMemberXML ${metadataName})"
        done
        echo "      $(generateNameXML ${metadataTypeName})"
        echo "  </types>"
    fi

}


#######################################
# Generate Package.xml
# Arguments:
#   api version
# Returns:
#   xml
#######################################
function generatePackageXML(){
    local apiVersion=$1

    local describeMetadata=$(sfdx force:mdapi:describemetadata -a ${apiVersion} --json | jq -r '.result.metadataObjects | .[] | "\(.xmlName) \(.inFolder)"' | tr '\r' ' ')
    
    echo '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
    echo '<Package xmlns="http://soap.sforce.com/2006/04/metadata">'
    IFS=' '
    while read -r metadataType inFolder; do
        local typeXML="$(generateTypeXML ${apiVersion} ${metadataType} ${inFolder})"
        if [ "${typeXML}" != "" ]; then
            echo "${typeXML}"
        fi
    done <<< "$describeMetadata"
    echo "  <version>${apiVersion}</version>"
    echo '</Package>'

}


#######################################
# Main function
# Arguments:
#   api version
#   path to the package xml to output
# Returns:
#   package.xml file
#######################################
main() {
    local apiVersion=${1:-'45.0'}
    local outputFile=${2:-'package.xml'}
    generatePackageXML ${apiVersion} > ${outputFile}
}
 
main "$@"

Hi, nice code!!! But when I executed are not separating of metadata type, instead are putting it all together.

And also when executing are showing several lines like:
./GenerateFullPackageXML.sh: line 99: -1: substring expression < 0

Best regards

Ditto what @oriolete said, nice code and appreciate how concise it's setup and the use of jq.

In regards to the not separating the metadata type for me, I modified the newline translate from tr -d '\n' => tr '\n' ':'

Hi @michael-adam-sheehan, I've forked this code with other new upgrades, feel free to use too. https://github.com/oriolete/GenerateFullPackageXML Best regards El vie., 4 oct. 2019 a las 4:48, Mike Sheehan (<[email protected]>) escribió:

…

Ditto what @oriolete <https://github.com/oriolete> said, nice code and appreciate how concise it's setup and the use of jq. In regards to the not separating the metadata type for me, I modified the newline translate from tr -d '\n' => tr '\n' ':' — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <https://gist.github.com/2ba2268ea0300fdfce78478defd158e1?email_source=notifications&email_token=ABVJUOCB4JUCKAZ6EJC55ALQM2VGFA5CNFSM4I5KPGM2YY3PNVWWK3TUL52HS4DFVNDWS43UINXW23LFNZ2KUY3PNVWWK3TUL5UWJTQAFZ3US#gistcomment-3045193>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABVJUOEK3MZL6CVNB7ZOLB3QM2VGFANCNFSM4I5KPGMQ> .

Thanks man ❤️

Hi, I need urgent help!! Your script is working properly while running locally from bash but when I am running this script from Jenkins, I am getting this error. What could be the reason??

2021/03/15 18:26:32 Begin Generate Package XML
jq: error (at :9): Cannot iterate over null (null)
2021/03/15 18:26:37
Usage: grep [OPTION]... PATTERN [FILE]...
Try 'grep --help' for more information.
GenerateFullPackageXML.sh: line 153: [: -eq: unary operator expected
2021/03/15 18:26:42 End Generate Package XML
Finished: SUCCESS