Pull Request Support for Azure Cloud
Pull requests let your team give feedback on changes in feature branches before merging the code into the master branch. Reviewers can step through the proposed changes, leave comments, and vote to approve or reject the code.
Previously, we had GitHub and Bitbucket support. We've included support for Azure DevOps in the ARM 21.6 release.
For each pull request created inside AutoRABIT, you will have a link that will redirect you to the Azure DevOps application externally where you can view the code changes, merge the changes and close the pull request. But, if there are problems with the proposed changes, they can post feedback in the pull request. Follow-up commits will show up right next to the relevant comments.
There is also a provision to approve the pull request within the AutoRABIT application as well.
Before You Begin
- Enable Pull Request support for users in AutoRABIT.
- The account owner or admin can assign the required permission to the users by visiting the Admin > Roles tab and selecting the 'External Pull Requests' checkbox under the Version Control section.
- Pull Request support is enabled for the Azure Cloud plugin.
- Make sure the Azure Cloud checkbox is selected under the My Account > Plugins > Pull Request Support section.
- Users have appropriate roles or permissions to integrate their repository for pull requests.
- Such privileges are granted by their account owner or admin. They can assign the required permission to the employees by visiting the Admin > Roles tab and selecting the 'Create Pull Request' checkbox under the 'Special Permissions In Version Control' section.
- The Approver should have the Pull Request Approver permission.
- Your version control repo should be eligible for the Azure cloud pull requests.
- Go to VC Repo's section and look for your repository.
- Select the checkbox: Enable Pull Request Support
- Select Azure Cloud as a pull request plugin.
- Click Save Details.
Creating a Pull Request
From the AutoRABIT tool, you can create a new PR from:
- from External Pull Request summary page
- during EZ-Commit.Point to Note:Currently, creating new PRs while running a new CI Job isn't supported. To date, both GitHub and Bitbucket allows you to create a new PR.
1. Creating a new Pull Request from the External Pull Request Summary page
- Go to Version Control > External Pull Requests.
- Click on the Create Pull Request button on the right side of the page.
On the next pop-up screen, furnish the below details:
- Select your version control repository. Only those version control repositories for which the pull request is enabled will be listed under the Repositories drop-down.
- Choose the Source branch and the Destination Branch to compare.
- Enter a Title and detailed Description of your changes, so others can see what problems the changes solve.
- Add reviewers' details that will accept your pull request. As you enter a name or email address, a list of matching users appears. Select the names to add as Required reviewer or Optional reviewer.
- Additional checkbox to delete the source branch once the pull request has been approved.
- Click OK. The newly created pull request will get displayed on top of the list on the External Pull Request Summary page.
2. Creating a Pull Request during EZ-Commit
- From the top navigation pane, go to Create New > New EZ-Commit.
- On the EZ-Commit screen, select the Salesforce Org from which the metadata components will get fetched.
- Select the Salesforce Org registered Author.
- Select the Version Control Repository for which the pull request support is enabled. Select its mapped branch.
- Select the way to fetch the metadata components from the selected Salesforce Org under the Fetch Changes section. Choose the one that best fits your needs.
- Under Perform section, select the option: Create a Pull Request
- Leave the remaining field as default and click on the Next button to proceed ahead.
- On the next page, select the metadata components and their members to be committed to the Version Control branch. Click Next.
- On the next screen, you need to do the following:
- To include your globally selected profiles/ permission sets to the commit, select the checkbox: Apply Global Profile Permissions
- Apply Search and Substitute Rules: If you have created the SEARCH and SUBSTITUTE rules to define custom find and substitute rules, AutoRABIT applies whenever you commit and deploy files from one Sandbox to another Sandbox one Sandbox to Version Control or vice-versa, such rule can be found here.
- Enter the Commit Comment. This is a mandatory step.
- Under Create a Pull Request section, choose where you like to commit i.e., in your base branch, or create a new branch and commit under it.
- To create a new branch and later commit the changes, enter the new branch name.
- Give the Pull Request a Label Name.
- Once all the fields are filled in, click on Finish. This concludes the creation of a pull request and is ready for review. After you create a pull request, you can ask a specific person to review your proposed changes.
- Once the commit process is initiated, you will be redirected to the Commits screen where you can view the progress of your commit operation initiated.