Builds

5 minute read

Overview

Build page enables you to view the daily recommended Build, or weekly recommended Build you build for an On-prem product. In this page, your focus is mainly on the status of your daily or weekly Builds. You can select your particular Build and view the details.

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

Builds layout

To view the Builds summary, do the following:

  • On the Product UI, click Builds. The Builds page opens.

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

    • Filter and view your actions based on the following filter options:

      • Group: Select the group in which you are working to view the build status of each Build.

      • Pipeline: Select the pipeline in which you are working to view the build status of each Build.

      • Build: Select the build stage.

      • Duration: Select the time duration to see the status of Builds for a selected time period.

    • Based on your selected filter option, you can view a list of Builds with the following details in a tabular format:

      • Build Date/Time: Displays the date and time when the Build was made.

      • Build ID: Displays the Build ID.

      • Commit ID: Displays the unique Commit ID.

      • Pipeline: Displays the pipeline name.

      • Pipeline Status: Displays the status of the pipeline starting from the Build step.

  • For the highlighted Build in the table, you can view the visual representation of the Build You can click on each build to view the status.

    undefined

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

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

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.

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

When an External Pipeline is integrated in Pipeline definition the build information is displayed.

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.

    • Success: Displays the number of successful test runs.

    • Failure: 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 passed 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.

Error detection in a 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 Failure. 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 end time of the commit.

    • Suggested Root Cause: Displays the root cause for the build failure from the remote Git repository and shows the reason. 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 failure. 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)