Working With Git - JJLongoria/aura-helper GitHub Wiki
Aura Helper are designed with GIT, DevOps and Continous Integration in mind (including Aura Helper Framework and Aura Helper CLI) and with this purpose, Aura Helper has to many tools to work with GIT and DevOps workflows easy, with less git conflicts or file errors.
Maintenance local project integrity is specially important when working with git, because the local project is also the git data and finally the data to deploy.
Aura Helper has to many tools and commands to maintencance the project integrity easy, Some of these tools are:
- AuraHelper: Metadata Comparator: Compare Local project with against Auth Org to get Metadata Types differences.
- AuraHelper: Repair Project Dependencies: Check Dependencies errors on any XML Files or repair it automatically.
- AuraHelper: Ignore Metadata from Project: Ignore Metadata Types files or Metadata Types into other files from your project. Also can ignore some user permissions from any permissions file.
Retrieve data into the local project its easy with Salesforce Org Browser, but, in many cases, the org browser retrieve more data than you need or can't select some Metadata Types like Validation Rules, Custom Fields...
When work with git, is important to retrieve only the modified data to maintenance the branches integrity and not include data from other features or dirty data. To retrieve the specified data and no more, you need retrieve data with a package XML
file, and Aura Helper implements a powerful Package Generator Tool to create package XML from to many sources and retrieve only the specified data.
Other importan tool to retrieve data to the project, is the AuraHelper: Retrieve Special Types command to retrieve the entire data from special Metadata Types without modify any other file and maintenance the branches and features integrity.
In to many cases, working with XML files and GIT can be difficult or consume to many time because some XML elements move into the file and git detect changes or conflicts that really not exists, or identify some open and close tags wrong and difficult resolving git conflicts.
To maintance all XML Files integrity and make identify changes for GIT and humans, reduce conflicts errors and working faster with XML files when push or pull data, Aura Helper implements tools to Compress selected XML file or Compress ALL XML Files from the project or selected folder (and subfolders).
Aura Helper always grant the same order into the XML files to make easy detect git changes and reduce conflicts. You can customize the order from Aura Helper Preferences with **Aurahelper › Metadata > Xml Sort Order**
setting
Working the permission files and GIT can be specially delicate depending on the characteristics of the project because retrieve Permission files can be dangerous because can retrieve more permissions than you need, or permissions from other features among other things.
AuraHelper: Retrieve Special Types command can be helpful to work with permissions but, the best tools from Aura Helper to work with permissions are AuraHelper: Permission Editor to edit any permissions files directly from local and VSCode without errors or AuraHelper: Modify Permissions to edit the permissions from any Metadata Types in to many files. With these tools, not need to connect with Salesforce to edit permissions secure without errors.
The most important thing when working with git, is deploy only the git changes and features and no more. To make this task really easy, Aura Helper has the Package Generator Tool to create Package and Destructive XML files from the differences of two branches, tags or commits.
The Package Generator Tool can detect created, edited or deleted files from any Metadata Type, including Metadata Types into other files like Workflow Actions, Custom Labels... The detecting changes precission is the 100%.
All above features can be automatized with the command line or using other tools like Jenkins with Aura Helper CLI to make the to much tasks automatically.