Register and view build artifacts

2 minute read

By registering build artifact metadata to CloudBees platform, teams can view and manage artifact information, including compiled binaries, configurations, and log files. Configure your CI pipeline to view generated artifacts from your build in CloudBees platform, including information about the version, the digest, the location, and any labels, if applicable.

Configure your Multibranch Pipeline to register build artifacts

Register any outputs of your integrated CI pipeline build workflow run, such as compiled binaries and log files, to CloudBees platform.

To register artifacts from your CI build to CloudBees platform:

  1. Complete the five steps in CloudBees CI / Jenkins® and CloudBees platform: Getting started.

  2. Specify a registerBuildArtifactMetadata step in your Jenkinsfile that contains the required inputs listed in the table below:

    Table 1. Input details
    Input name Data type Required? Description

    name

    String

    Yes

    The name of the artifact reported to CloudBees platform.

    url

    String

    Yes

    The URL where the artifact version is located. For example, docker.io/myapp/myimg:1.0.0.

    version

    String

    Yes

    The version of the artifact to send to CloudBees platform for artifact traceability purposes.

    digest

    String

    No

    The hash or checksum that uniquely identifies the artifact version.

    CloudBees recommends specifying the digest to track artifact versions across repositories. For more information, refer to Artifact deployment and publish history.

    label

    String

    No

    A comma-separated list of artifact labels.

    type

    String

    No

    The type of artifact, such as Docker or Maven.

The following step in an example Jenkinsfile is used to register build artifacts in CloudBees platform:

pipeline { agent any stages { stage('Registering build artifact') { steps { echo 'Registering the metadata' registerBuildArtifactMetadata( name: "test-artifact-example", url: "http://localhost:1111", version: "1.0.0", digest: "12345678901234567890123456789012", label: "prod", type: "docker" ) } } } }

View CI build artifacts

View artifacts from your CI build in the same platform as all your other DevOps projects.

To view the artifacts for a build, do one of the following:

  • Access the details for your CI build, and then select Build artifacts to list only the artifacts generated during that build.

  • Select your component, and then select Artifacts to list all artifacts associated with a component. Choose to display just the latest versions or the entire version history.

CI build artifacts
Figure 1. A CI build artifact list.

Learn more

For more information on artifacts, refer to: