Commits and builds

5 minute read

Overview

CloudBees Release Orchestration SaaS enables you to view all commits and builds, including their status, and a visual representation of the pipeline from commit to production. Build summary, test results details, deployment summary, and success or failure status are all available. You can find where a given failure is, who should be notified, and how it can be fixed. Because you have visibility into all errors in build, deploy, test, and custom steps, you can make informed decisions leading to successful deployments.

You must have the Admin, Developer, QA, or Manager role to access Orchestration  Commits and Orchestration  Builds.

Accessing commit and build information

You can filter a list of commits or builds, display a visual representation of a selected pipeline, and display details of the pipeline execution.

Table 1. Pipeline details displayed on Orchestration  Commits and Orchestration  Builds
Detail Orchestration  Commits Orchestration  Builds

Average deployment lead time (the average time taken for a commit to reach production)

Commit date/time

Build date/time

Build ID

Commit ID

Pipeline name

Description

Developer

Pipeline status

Deployment lead time (the time a commit takes to reach production)

To access commits or builds:

  1. From the CloudBees Release Orchestration SaaS Home page, select one of the following:

    • Orchestration  Commits  Post Merged

    • Orchestration  Commits  Pre Merged

    • Orchestration  Builds

      Builds
      Figure 1. A list of builds
  2. Select how you want to filter from the options:

    • Pipeline group

    • Pipeline name

    • A time duration

    • Your own commits (not available on Orchestration  Builds)

    • Code branch (not available on Orchestration  Builds)

      list of builds
      Figure 2. Filtering builds by pipeline group, name and timeframe
      Filtered commits
      Figure 3. Filtering commits
  3. Select a commit or build.

    The steps displayed in the pipeline are based on the pipeline definition made in Orchestration  Pipeline Composer. On the visual representation of the pipeline:

    • A green checkmark icon marks a passing step.

    • A red exclamation point icon marks a failing step.

    • The time taken is displayed below each step.

  4. Select any of the following:

    • The commit ID to display the commit in the repository.

    • Expand to display the pipeline in an expanded view.

    • A stage environment to access test results. To learn more, refer to refer to Accessing a test summary.

    • Current Builds for any environment to display the current list of builds for that environment.

  5. If a stage has a WAITING For Approval pipeline status, and you are the approver, you can provide your feedback. To learn more, refer to Approving/rejecting a pipeline execution.

    Current builds
    Figure 4. An example of current builds on the stage environment
    • Select any completed stage in the pipeline execution to display a summary, including:

      • Build ID

      • Build date and time

      • Pipeline name

      • Commit ID

      • Developer

    • From a completed stage summary, select View Full Log to display the log file, including:

      • Build ID

      • Number of commits

      • Start time

      • End time

      • Open bugs

    • Select a completed step in the pipeline to display the console log for the step.

You have filtered and displayed a list of commits or builds, including selected details and a visual representation of the pipeline.

In Orchestration  Builds, you can select the build ID to display:

  • Commit date and time

  • Commit ID

  • Description

  • Developer

If a PR is merged in Orchestration  Commits  Post Merged, you can select the linked list of commits in the feature branch to display all the linked commits.

Accessing a test summary

The CloudBees Release Orchestration SaaS test summary provides useful information, including testing duration, number of successful and failed test runs, and logs for each test.

To access test summary details:

  1. From the CloudBees Release Orchestration SaaS Home page, select one of the following:

    • Orchestration  Commits  Post Merged

    • Orchestration  Commits  Pre Merged

    • Orchestration  Builds

  2. Select a build or commit.

  3. Select a stage environment or select Expand. The test results are displayed as vertical bars.

    Test suites
    Figure 5. Test results are displayed above the environment
  4. Select a bar:

    • A green bar indicates passing tests.

    • A red bar indicates failed tests.

    • A gray bar indicates no data.

      Test details
      Figure 6. An example of test summary details

The test summary details are displayed. These include:

  • The Environment where test suites are run.

  • The Start Time of testing.

  • Time Taken (the testing duration).

  • Total Tests in the suite.

  • Success (the number of successful runs).

  • Failure (the number of failed runs).

  • A link to the logs for each passed test.

  • A link to the root cause for each failed test.

  • Any pending open bugs.

Identifying a rolled back commit

A red rollback icon next to Commit ID indicates that the current commit is rolled back to the previous commit. To learn more, refer to Enabling rollback.

Rollback pipeline view
Figure 7. An example of a rolled back commit with rollback icon highlighted

Select Rollback History to display the stage history, including:

  • The build ID for the commit that was rolled back

  • Current build ID

  • Time and date of rollback

  • Email of the person who did the rollback

  • Any comments

Identifying a hotfixed commit

An orange HF icon next to the Commit ID indicates that the current commit is hotfixed. A hotfix is useful to modify a commit if there is an issue in an environment, but you still want to deploy a build.

Hotfixed commit
Figure 8. An example of a hotfixed commit with HF icon highlighted

Restarting a pipeline

If your pipeline fails, you may be able to restart it. Pipelines that can be restarted will have RESTART available above the failed stage.

To restart a pipeline:

  1. From the CloudBees Release Orchestration SaaS Home page, select one of the following:

    • Orchestration  Commits  Post Merged

    • Orchestration  Commits  Pre Merged

    • Orchestration  Builds

  2. Select a commit with a FAILED pipeline status.

  3. Select RESTART above the failed stage.

    Restart
    Figure 9. Restarting a pipeline
  4. Select PROCEED.

Your pipeline restarts.

Verifying the deployment

CloudBees Release Orchestration SaaS features deployment verification. Deployment verification determines if a critical problem is present after deployment. A red icon displays if there is a failure. For more information, refer to Verifying deployment.

Deployment verification
Figure 10. Deployment verification

Selecting the failed deployment verification icon displays:

  • Health rules violated

  • Violation summary

  • Start time

  • Severity

  • AppD link

Failed deployment verification information
Figure 11. A failed deployment verification example

Detecting errors in a failed pipeline

You can view pipeline activity logs and diagnostic information to track each failed step in the CI/CD process and fix the issues.

For more information on failed automated tests, refer to Test summaries.

To detect an error in a failed pipeline:

  1. From the CloudBees Release Orchestration SaaS Home page, select one of the following:

    • Orchestration  Commits  Post Merged

    • Orchestration  Commits  Pre Merged

    • Orchestration  Builds

  2. Select a build or commit with a FAILED status.

  3. Select the failed stage, which is highlighted in red, and is marked with an exclamation point icon.

  4. A log opens. The information displayed includes:

    • Start and end time

    • Build ID

    • Number of commits

    • Open bugs reported

      The highlighted code is the suggested cause for failure.

      For some failed steps, there is both a Root Cause log and All logs.

      Select All Logs to display the complete log. You can select the following log types:

      • CI Console (console logs in real time for every build)

      • CI-Infra

      • Build System

      • Build-Infra(K8S)

    Root cause logs
    Figure 12. The root cause of a failed pipeline stage
  5. (Optional) Select FILE A BUG to report a bug in Jira.

You have detected the error in a failed pipeline.