Commits

7 minute read

Overview

Commits enables engineers to view the consolidated list of all the commits for all groups. You can also view the status of each commit. You can also have a clear visibility into the bottlenecks in the Build, Deploy, Test, and custom steps, giving you information to make informed decisions and fix the bottle necks in time to error free deployments.

You can view this page only if you have the access controls of an Admin, Developer, QA, or Manager.

The Commits page enables you to view the status of your check in. You can view the complete status of your check-in in the pipeline, along with its Build summary, test results details, deployment summary, and how it has successfully reached production.

Complete Visibility: The Commits Summary enables you to view the pipeline execution, diagnose the release pipeline and find out the Build failures, Deploy failures, Test failures, and custom failures, if any to mitigate any risk, so that your check-in can move forward to production.

Early detection and mitigation: If you find a failure in the check in, with one-click you can find exactly why and where the failure happened. It gives you visibility into where the failure is, who should be notified, and how it can be fixed, so that your check-in can move forward.

Commits layout

  • In the Commits page, click on a successful pipeline where a commit has been successfully pushed.

    undefined
  • On the page, you can view the following details:

    • You can filter and view the commits based on the following filter options:

      • My Commits

      • Group

      • Pipeline

      • Branch

      • Duration

    • You also can view the following commit details of all developers in the team, in a tabular format:

      • Avgerage Deployment Lead Time: Displays the average time taken for a commit to reach production.

      • Commit Date/Time: Displays the date and time of the commit.

      • Commit ID: Displays the unique Commit ID.

      • Description: Displays a short description of the commit.

      • Developer: Displays developer of the commit.

      • Pipeline: Displays the pipeline name for which the check-in is made.

      • Pipeline Status: Displays the status of the The available statuses are:

      • Deployment Lead Time: Displays the complete time a commit took to reach production.

  • On the bottom of the page, you can view the complete visual representation of the code commit – from commit to production for the selected pipeline.

  • Linked Commits: If a PR is merged, It shows the list of linked commits in the Feature branch.

    undefined
  • On clicking on others in Commit ID, you get to know the complete details of all the linked commits.

    undefined
  • The color definition of each individual step is set to display Passed in Green, and Failed in Red color.

  • Time taken for each step is also displayed at the bottom of each For example: Build – 3 seconds

  • Current Build: Displays the details of the current build on parallel running on the stage, which came in after you have checked-in your commit.

    undefined
  • By clicking on the individual step in the pipeline execution, you can view a detailed description of each step in the release

Successful pipeline view

Let us now see with an example how a successful commit goes through each step in the pipeline and how it is being executed, how you can find the bottle necks in Build, Deploy, and test phases, and how to get them fixed to move the check-ins into production.

You check your code into a SCM repository several times a day. Automated build pipelines are triggered whenever this check is happen and help in the detection of errors. So, you can fix the errors and progress towards production.

External pipeline view

The progress of a commit in each stage in an External Pipeline is displayed with a clickable view of each stage in both successful and failed state to support troubleshooting.

Successful external pipeline view

Let us now see with an example how a successful commit goes through each stage in the External pipeline and also the steps in the External pipeline passes.

Failed external pipeline view

The below described is an example for failed External Pipeline stage, if any step in External Pipeline failed. The particular commit stops its way reaching to production.

The pipeline definition you view here is based on how you have defined your pipeline in the Admin portal.

  • Build: Click Build to view the following build details:

    • Build ID: Displays the Build ID.

    • Build Date and Time: Displays the date and time when the commit has progressed to Build step.

    • Pipeline: Displays the pipeline for which the commit has been made.

    • Commit ID: Displays the Commit ID.

    • Developer: Displays the name of the developer responsible for the Build.

      undefined
  • Deploy: Click the next step Deploy to Stage to view the following details:

    • Build ID: Displays the Build ID.

    • Build Date and Time: Displays the date and time when the commit has progressed to Deploy step.

    • Pipeline: Displays the pipeline for which the commit has been made.

    • Commit ID: Displays the Commit ID.

    • Developer: Displays the name of the developer responsible for the deployment.

      undefined
  • Stage Environment: Click on the next step, Stage environment to view the test Suites run on the commit (represented here as horizontal bars).

    undefined
  • Test Suite: Click on the Single green bar representing a test suite/(s) run and view the following Test Summary details:

    undefined
  • On the Test Summary page, you can view the following test results information:

    • Environment: Displays the environment on which the test suites are run.

    • Start Time: Displays the start date and time of the test suite run.

    • Time Taken: Displays the time taken for the test suite to complete running.

    • Total Tests: Displays the total number of tests run in the environment.

    • Successes: Displays the number of successful test runs.

    • Failures: Displays the number of failed tests runs.

    • Failed Test Details: Displays a comprehensive details on the failed tests.

    • Passed Test Details: Displays a comprehensive details on the tests that have passed.

      • Test Name: Displays the test name.

      • Root Cause: Displays the suggested root cause for the failed test.

      • Open Bugs: Displays any bugs pending.

  • Click on the next step, Prod-Internal, to view the following build summary:

    • Build ID: Displays the Build ID.

    • Build Date and Time: Displays the date and time when the commit has progressed to deployment step.

    • Pipeline: Displays the pipeline for which the commit has been made.

    • Commit ID: Displays the Commit ID.

    • Developer: Displays the name of the developer responsible for the commit.

      undefined
  • Click on the next step, Deploy to prod, to view the following details:

    • Build Date and Time: Displays the date and time when the commit has progressed to production step.

    • Pipeline: Displays the pipeline for which the commit has been made.

    • Commit ID: Displays the Commit ID.

    • Developer: Displays the name of the developer responsible for the commit.

      undefined

The steps you view in the pipeline is based on your pipeline definition made in the Admin portal.

Rollback pipeline view

The below described is an example for rollback, red reverse icon indicates that the current commit is Rollbacked to Previous Commit.

Clicking on Rollback History will show the History of Rollback like from build and to build of the rollback, time and rollbacked by with comments.

Hotfix pipeline view

The below described is an example for hotfix, orange HF icon indicates that the current commit is hotfixed. Hotfix is used when there is any issue in any environment and want to deploy some specific build.It Indicates that the current commit parameter is modified and the HotFix Checkbox is selected.

Deployment verification in pipeline

After deployment, Deployment Verification verifies whether any critical problem arises in the process for a specific duration and shows the following results. The green icon in the pipeline shows the Deployment Verification is Successful.

The red icon in the pipeline shows the Deployment Verification is failed.

On clicking the failed Deployment Verification icon, it shows the following information.

Error detection in failed pipeline

Let us now see an example of a Failed Pipeline (highlighted in red) and how you can detect the failures in the pipelines and fix the issues with a single click. This page enables you to view the activity logs, diagnostic information, and bottlenecks. Using these logs, we can track each step in the CI/CD process and proactively monitor for problems.

Diagnostic information for a build failure

  • Click on the pipeline that has failed to progress to Production and view the root cause for the failure and quickly resolve it.

    undefined
  • The above pipeline has failed due to a Build Click on the Build Failure step to view the diagnosis.

    undefined
  • On the Build Summary window, with a single click you can view the following details:

    • Build ID: Displays the Build ID.

    • Number of Commits: Displays the number of commits made.

    • Start Time: Displays the start time of the commit.

    • End Time: Displays the start time of the commit.

    • Suggested Root Cause: Displays the root cause for the build failure from the remote Git repository and shows the The yellow highlighted content shows you the suggested cause for failure.

    • Commit ID: Displays the Commit ID.

    • Open bugs: Displays if there is any open bug has been reported for the failure.

    • File a Bug: Click File a Bug, and report a bug in JIRA.

    • All logs: You can click All Logs to view the complete log of the The page opens in a new window and you can view the complete log.

      undefined
  • Under All Logs, you can view the following detailed information on the failure:

    • CI Console: Displays the console logs in real time for every build.

    • CI-Infra

    • Build System:

    • Build-Infra(K8S)

To restart the pipeline

To restart the pipelines do the following:

  • Click on the pipeline that has failed to progress to Production and click the restart button above the particular pipeline stage.

    undefined
  • The popup will open and if the pipeline needs to be restart give PROCEED.

    undefined
  • Click on the Approve button above the particular pipeline stage, the popup will open and if the pipeline needs to be move to next stage give APPROVE else give REJECT.

    undefined