/ALM-SF-Metadata-API-Python-Tools

ALM SF Metadata API Python Tools

Primary LanguagePythonApache License 2.0Apache-2.0

Salesforce ALM Framework - Python Scripts for Metadata API

Python scripts to perform ALM (Application Lifecycle Management) operations over Salesforce platform using metadata API. The DX version can be found at ALM-SF-DX-Python-Tools.

These scripts can be used standalone or invoked from CI/CD pipelines, such as the Jenkins pipelines from ALM-SF-Metadata-API-Pipelines.

Call Git Server

Handle Git operations between several Git distributions.

Currently supporting:

  • Gitlab
  • Bitbucket Cloud
  • Bitbucket Server

Detailed explanation can be found at Call Git Server README.

Generate Package

Creates a package.xml from a JSON.

Detailed explanation can be found at Generate Package README.

Merge Metadata

Merges splitted components into destination metadata. Instead of comparing two files, this script can be used to automatically merge a retrieved package with individual components, such as Custom Fields, Custom Labels, Sharing Rules, .. or Profile permissions.

Detailed explanation can be found at Merge Metadata README.

Merger

Builds a package with differences between source and target branches or commits.

Detailed explanation can be found at Merger README.

PMD

Creates a customizable report from a PMD analysis.

Detailed explanation can be found at PMD README.

Send Email

Sends an email showing the pipeline results and attaches PMD and/or deployment logs.

Detailed explanation can be found at Send email README.

Contributors Guide

Contribution

We encourage you to contribute to new features or fixes. You can start by opening a Github issue to get feedback from other contributors.

License

The Salesforce ALM Framework is licensed under the Apache License 2.0 - see LICENSE for details.