Commits Summary
  • 14 Nov 2022
  • 8 Minutes to read
  • Contributors
  • Dark
    Light

Commits Summary

  • Dark
    Light

Commits Summary

In AutoRABIT, you can see descriptions of every commit or merge, including a diff in the commit/merge modifications implemented. Commits are segregated on the basis of the date the commit was committed in AutoRABIT. By default, only the commits of the logged-in user are listed in reverse chronological order; that is, the most recent commits are first shown.

Navigate to the Version Control > Commits to view the Commits screen.

The Commit Summary screen is best viewed when the zoom setting is set to 80% on your chrome/firefox browser.

To see all your teammates commit, simply turn Created By Me toggle bar to the left side, and all the commits will be shown there. Or, filter the commits for which the reviewer approval is in the pending state by moving the Pending Approvals toggle bar to the right side.

It's also possible to search for commits based on the content. To filter the exact commit, you can enter the commit label, revision number, or comment in this search field.

Content search is case-sensitive.

Each commit shows:

  1. Commit identification Initials whether it is prevalidated commits (PV), commit (EZ), merge (M), or validate and merge (VM)
  2. The commit label name
  3. The commit message
  4. The committer's username
  5. The date the commit was created
  6. Version Control Repository, Destination, and Source Branch details
  7. Salesforce Org details (applicable only for prevalidated commits and EZ-commits)
  8. Commit Revision label
  9. Commit/Merge status

About Quick Merge

Quick Merge allows you to quickly merge your changes to a Version Control branch directly from the Commits screen. 

Suppose you’ve committed your changes to a child branch and are now ready to be merged into your master branch. In order to do that, you can hover the mouse over the 3 dots at the right side of the screen and click on Quick Merge to quickly merge the changes into your master branch, rather than navigating to the New Merge screen and configuring the steps once again.

You'll have a pop-up that will ask for your permission to proceed with the Quick Merge operation.

Scenarios where Quick Merge is not applicable
  1. For Prevalidation Merge commits whose approval is in the pending stage
  2. Quick Merge is not applicable for merged commits

Commits Detailed View

You can view the detailed commit report by hovering the mouse over the 3 dots at the right side of the screen and clicking on Detailed View.

Important Note:
For prevalidated commit or merge, one can also view the detailed view by clicking on 3 dots beside the Commit label name.Detailed view
For failed commit/merge prevalidation, the red dot symbol next to 3 dots for the commit labels will easily distinguish it from the rest of the commits list.Deployment validation

The detailed report covering commit type, commit label, comment, source org, repo/branch, reviewer details, etc., will display on the top of the page.  In short, the features chosen by you during merge/Ez-commit are seen here.

Clicking on the drop-down icon will display in-depth features that you chose during the Merge/EZ-commit process.

The pull request element will display only for the EZ-commit process (not for Merge and Pre-validation merge).


Important Notes:
  1. Only the EZ-Commit process will display the pull request element in the drop-down (not for Merge and Pre-validation merge).
  2. A ticked state pull request denotes that the EZ-Commit process was successfully triggered with a pull request enabled, which also means the pull request for the commit will be failed for the cross (X) status.
  3. Clicking the Pull Request link will take you to the pull request page for your GIT/Bitbucket in a new tab. However, the link will be disabled for pull requests in failed status.
  4. The EZ-commit process created long ago will not have a link to take you to the Pull Request screen because the pull request status has recently been introduced on the Detailed View screen.

You can even view the step-by-step process that took place for your commits to complete.

View your reviewer comments if any under the Reviewer Comments section. Reviewer comments

The commit log details, together with ALM details, code analysis report, metadata changes report, deployment validation report can also be viewed here.commit log details

  1. Log: Contains the detailed history of the check-in performed. We also provide you with an option for downloading the log report and saving it on your local machine.validating credentials
    Important Note:
    For each operation performed in the commit phase, the log report will be available. A () mark against each log segment shows the completion of the operation; you will have () and () icons respectively present against each log segment for a failed and partially successful operation.
  2. Deployment Validation (for Commit/ Merge prevalidation): AutoRABIT performs a check-only deployment to your destination branch. Nothing will be deployed to your destination branch, however, if anything goes wrong - for example, the deployment fails, or tests don’t pass - we’ll show you exactly what happened, so you can fix it.Deployment validation
  3. Code Analysis File: Static Code Analysis is usually performed as part of a Code Review and is carried out at the Implementation phase of a Security Development Lifecycle (SDL). Static Analysis tools such as PMD and Checkmarx continuously detect and report on dataflow problems, software defects, language implementation errors, inconsistencies, dangerous usage, coding standard violations, and security vulnerabilities.

    SCA will have information for both PMD and Lint reports (the Lint report will display information about AuraBundle components files only). This report will have info about the files that were reviewed and the related violations that occurred. Click on each file to view its related violations that will appear at the bottom right side of the page. If you click on any violation, it will take you to the respective line (in the black screen on the right side) where such violation occurred.

    Download the ApexPMD/Lint Report: 
    Get the report in XLSX format in your local machine using the Download ApexPMD/Lint Report button.
    ApexPMD/Lint Report
  4. Files Changed: AutoRABIT compares the metadata between the base branch and the destination branch (for merge) and source salesforce org with the destination branch (for EZ-Commit operation) and generates a metadata difference report and log detail. Such information can be viewed in this tab. This tab will display the number of insertions and deletions to each metadata file. The lines highlighted in RED color indicate those are modified (added/updated/deleted) either in the source salesforce org/branch and for GREEN color indicates those are modified (added/updated/deleted) in the destination branch. The modified lines are the highlighted lines.Files changedExpanding each component will allow:
    • viewing the inline comparison between the source and the destination files 
    • the inline comment is allowed for each file
    • the modified lines are the highlighted ones
    • and downloading of individual metadata file changes report using the Download icon.Expand each component
  5. ALM Details: View the ALM configured during your commit/merge operation.ALM Details
  6. Comments: Add/ Edit/ Reply comments for each commit process on this tab.comments

Commit Status

  1. Completed: This indicates the commit/merge has been successfully done with no conflicts. View the revision detail for each completed commit/merge.
  2. Failed: The commit operation has failed. Here, you can re-push the failed commits once the changes are updated (for prevalidation commit) or view the detailed report for the commit to fail (for validating and merge).Failed commit
  3. Merge Conflicts: Sometimes you get merge conflicts when merging or pulling from a branch. A Merge Report gives a detailed report of the conflicting files that occur during a merge. In such a scenario, you need to resolve the merge conflicts to proceed ahead. To do so, click on Resolve Conflict.Resolve conflict
  4. Auto Rejected: This will occur if the reviewer has failed to approve the pre-validate commit within the stipulated days as mentioned in Commit Validation - Approval Settings section (Admin > My Account > Commit Validation - Approval Settings).Auto Rejected
  5. Review Pending: For commits/merges where approvals are requested, the status will be shown as Review Pending. In such a scenario, the requested approvers need to approve the open request by clicking on Approve/ Reject button. Approve/RejectIt is mandatory to add comments while rejecting the open request. The comment is optional for approval.Comment approval
  6. No Modifications: If there are no metadata components differences during commits, you will find your commit with status as 'No Modifications'.No Modifications

Filtering the Commits

  1. By Repository and Branch: Filter the commits by version control repository and the branch.
  2. By Content: It’s also possible to search for commits based on the content. To filter the exact commit, you can also enter the commit label, revision number, or comment in this search field.
    Content search is case-sensitive.

  3. By Pending Approvals: Filters the commits for which the reviewer approval is in the pending state.
  4. By Date Range: You can pass a date range to show only the commits contained in that range.
  5. By Commits type: Filter the commits based on their type i..e., Ez-commit, prevalidated commit, merge, or prevalidated merge type.Prevalidated Ezcommit
  6. By Author: When you’re only looking for commits committed by a particular user, use the Committed By filter.
  7. By Board: Filter the commits based on the Salesforce or Vlocity commits.Salesforce or Vlocity commits

Delete Commits/Merges

If you want to redo or simply delete an incorrect commit/merge that has been initiated in ARM but not yet pushed to the repository, you do so from the COMMITS summary page by hovering your mouse over the 3 dots at the right side of the screen and clicking on Delete Commit.

On the Confirmation screen, click YES to permanently delete the commit/merge.

 

Important Notes:
  • Commits/merges can only be deleted by the user who has created the commit, or the org admin.
  • An approver will not have permission to delete a commit.
  • Commits once deleted cannot be retrieved.
  • Only the commits with the following status can be deleted:
    • Merged - No Modifications
    • No Modifications
    • Review Pending
    • Commit Pending
    • Failed
    • Auto Rejected
    • Merge Conflict
    • Waiting for Approval
  • Commits in Completed or Inprogress status cannot be deleted.

Once the commit is deleted, an automated email is sent to the user who created the commit, the user who deleted the commit, and the org admin.

Commit Workspace

The commits in the queue will get mentioned here when various commits get deployed to a branch. The main concept to introduce the commit workspace is to allow parallel commits from the same source org to different VC branches.

When you commit multiple times keeping the target VC branch the same, the commits will run one after another. This is applicable to your selected Salesforce Org.

The customer has an option to delete the commit that is in a queue if he no longer needs it.commit workspace

A consolidated merge request with the respective logs as an attachment is triggered to the Org Admin via email for better visibility for merge requests that are in the queue for more than 4 hours. A sample email notification is attached below for your reference:

Merge Requests

Deployment Workspace

The pre-validate deployments in the queue will get displayed in this space.Deployment workspace


Was this article helpful?

What's Next