Components

3 minute read

A component in the CloudBees platform is a piece of software, built and, if desired, released and deployed from source code.

Access a component

You can display the component list in a table or block view.

To access a component:

  1. Select Components from the left pane.

  2. (Optional) Select the Blocks icon to switch to a block view of your components, or select the Table icon to switch to a table view, as desired.

  3. (Optional) Search for a specific component, by entering all or part of a component name into Search.

  4. (Optional) Sort the component list in either of two ways:

    1. Select an option in Sort by; you can choose either ASCENDING or DESCENDING alphanumerical sort order.

    2. In table view only, select Sort icon next to a heading to sort on that heading.

      • Once sorted, either Sorted ascending (for ascending), or Sorted descending (for descending), is displayed to the right of the heading.

      • To switch an existing sort order, select Sort ascending, or Sort descending, as applicable (or select an option in Sort by).

      • The default sort is ascending by most recent status, in the order of:

        • FAILED

        • PENDING

        • STARTED

        • SUCCEEDED

      • In block view, components are ordered left-to-right by rows.

  5. (Optional) Select FILTER to filter the component list:

    1. Select from the STATUS options.

    2. Select to close the filter.

You are displaying components, listed according to any sorting, filtering, or searching you have done. To display specific information about a given component, refer to Access component details.

Access component details

Display component information details, such as build number, workflow, and run details.

To access component details:

  1. Select Components from the left pane. Expose the left pane, if necessary, by selecting on the left corner of the title bar.

  2. Select a component.

  3. Select COMPONENT DETAILS.

Details for your selected component are displayed.

Sort component details

Select COMPONENT DETAILS on a given component, to sort details.

Sort component information by either of two ways, as follows:

  1. Select Sort icon next to a heading to sort ascending (Sorted ascending) or descending (Sorted descending), according to that heading. Select again to switch sort order.

  2. Select an option in Sort by; you can choose either ASCENDING or DESCENDING alphanumerical sort order.

Your component information in COMPONENT DETAILS is sorted accordingly.

Filter component details

Select COMPONENT DETAILS on a given component, to filter details.

Filter component information by any of five ways, as follows:

  1. Choose an option from Select branch.

  2. Choose an option from Select workflow.

  3. Select FILTERS and choose one or more from the STATUS options.

  4. Select FILTERS and choose from the Author options.

  5. Select FILTERS and enter all or part of a commit message into Search.

Your component information in COMPONENT DETAILS is filtered accordingly.

Access run details

Display details for any component run.

  1. Select Components from the left pane.

  2. Select a component.

  3. Select COMPONENT DETAILS.

  4. Select Run details.

  5. Select any section from the run outline.

Select EXPAND ALL to open all sections and list all steps, or select COLLAPSE ALL to close all.
  1. Select a step to display the details.

  2. (Optional) Select and move the Resize icon to resize the run outline and details view.

You are displaying the details for your chosen run step.

Search run details

Search through details of any component run.

  1. Select any section from the run outline.

  2. Select a step to view the details.

  3. Enter all or part of a word into the search box to highlight it in the Run details view.

  4. Select or in the search box to step through the code.

  5. Select to clear the search.

You are displaying the search results for the chosen run details.

Create a component

Create any number of components.

To create a component:

  1. Select Components from the left pane.

  2. Select CREATE COMPONENT.

  3. Select a repository from the options, or enter by all or part of a repository name into Search, and then select a repository.

  • Select Hide connected repositories to display connected repositories as grayed out on the list.

  • Select Show connected repositories to include all repositories on the list.

  1. Select NEXT.

  2. Enter a Component name.

  3. (Optional) Enter a Description.

  4. Select CREATE.

Your component is created, and listed in Components. Refer to Create a workflow to start working with the component.

Update a component

Update the Component name or Description of a component.

To update a component:

  1. Select Component from the left pane.

  2. Select the next to the component you want to update.

  3. Select Edit component.

  4. Make any desired changes.

  5. Select SAVE.

Your component is updated accordingly.