Problem analyzer templates

How to create problem analyzer templates and assign them to CI jobs

Ana Juvandes avatar
Written by Ana Juvandes
Updated over a week ago

Gearset's problem analyzers are designed to make your deployments more likely to succeed by providing suggestions, either to remove or edit items in your deployment package.

For manual comparisons, you have the option to ignore some of the suggestions made by Gearset's problem analysis, and there's a chance that the deployment will still be successful. You might want to do this if you are, for example, deploying metadata changes to a source control repository.

For every continuous integration (CI) job you can select:

  • Apply all fixes, this applies all Gearset's problem analyzers to be run.

  • A custom Problem Analyzer template, in which you can select which problem analyzers to run

  • Don't apply any fixes, this leaves the package exactly as is and applies no problem analyzers to the CI job.

These Problem analyzers will run on every CI job run.

With the Automation Platform license you can create problem analyzer templates and assign them to your CI jobs. These templates allow you to configure which problems are identified by Gearset's problem analyzers and whether the related fixes should be applied to your metadata changes prior to deployment. Note that this may result in a deployment error/failure, as the purpose of the problem analyzer is to help it to succeed. You may need to address the Salesforce deployment errors in order to deploy successfully. However, in many cases, the deployment can still be successful.

Creating a new template

To create a new template, navigate to the Problem analyzer templates section in My Account and click Create new template. Here you will find the list of problems that can be enabled/disabled. The enabled ones will apply to your CI job.

Once you disable the ones that you do not want to be applied, and give the template a name, you can go ahead and save the template.

Assigning the template to a CI job

Time to head over to your CI jobs dashboard to assign the template. You can do this for existing and new jobs (For existing jobs, select Edit settings...). If you're already in the settings for a CI job in another tab when the new template is created, you would need to refresh the CI job settings tab for it to pick up the new template.

In the CI job configuration form, go to the tab Advanced settings. Select the template that you just created and press Save.

Now your CI job, as well as its validation-only child CI jobs, will only have the problem analysis fixes applied that are enabled as part of the template.

If you do not wish for a template to be assigned to a CI job anymore, you can change this option back to Gearset Default Analyzer Template (all problems enabled).

Deleting a template

Going back to the Problem analyzer templates section, you can also delete an existing template by pressing the red bin icon that shows once you select the template. Please note that before doing this you will need to make sure the template is not currently assigned to any CI jobs.

Did this answer your question?