Azure DevOps

Create Pipelines

You need to create two pipelines in Azure DevOps, using the YAML files provided in your project.

This pipeline will run validation checks on every Pull Request.

Go to Pipelines
Select New pipeline
Select Azure Repos Git
Select your repository
Select Existing Azure Pipelines YAML file
Select path azure-pipelines-checks.yml (select your work git branch if needed)
Click on Continue
Click on the arrow next to "Run" and select Save
Rename the pipeline to Check Pull Request (click on the name to edit)

This pipeline will deploy changes to the Salesforce org when a Pull Request is merged.

Go to Pipelines
Select New pipeline
Select Azure Repos Git
Select your repository
Select Existing Azure Pipelines YAML file
Select path azure-pipelines-deployment.yml (select your work git branch if needed)
Click on Continue
Click on the arrow next to "Run" and select Save
Rename the pipeline to Deploy to org (click on the name to edit)

By default, Azure Pipelines might trigger on every commit to any branch. We want to restrict this and ensure it runs for Pull Requests.

Disable Continuous Integration trigger:
- Go to Pipelines -> Select "Check Pull Request" pipeline -> Edit
- Open the menu ⋮ (Triggers)
- Tick Override the YAML continuous integration trigger from here
- Select Disable continuous integration
- Save
Configure Branch Policy:
- Go to Repos -> Branches
- Click on the ... menu next to your major branches (e.g., integration, master, ...)
- Select Branch policies
- In Build Validation, click +
- Select your "Check Pull Request" pipeline
- Keep default settings and Save
- (Optional but recommended) In Branch policies, enable Require a minimum number of reviewers and Check for linked work items if you want to enforce best practices.

This pipeline should run automatically when changes are pushed (merged) to major branches.

Configure Branch Filters:
- Go to Pipelines -> Select "Deploy to org" pipeline -> Edit
- Open the menu ⋮ (Triggers)
- In Branch filters, tick Override the YAML continuous integration trigger from here
- Ensure Enable continuous integration is checked
- Include all your major branches (e.g., integration, uat, production...)
- Save

In order to avoid to have to open job logs to see deployment errors, sfdx-hardis can post them as a thread on the Pull Request UI

To use this capability:

You must allow Contribute and Contribute to Pull Requests on your Build Service (Settings -> Repositories -> Select your build service)

If you want to use Flow Diff (visual diff of flow differences):

Create an Azure boards ticket exactly named sfdx-hardis tech attachments. IT will be used to link uploaded images.
- If you prefer to name it differently, define variable AZURE_ATTACHMENTS_WORK_ITEM_ID with the number of your ticket as value.

An Azure Work item can have only 100 attached images, so frequently delete old image attachments, or delete the ticket then recreate it with the same name.

Everytime you will make a pull request, the CI job will post its result as comment !

Notes:

This integration works with sfdx-hardis pipeline, but also on home-made pipelines, just call sf hardis:project:deploy:start instead of sf project:deploy:start !