Publish anything to the Artifacts tab

You can publish any URL to the Artifacts tab on the Build details page. To do this, you need to:

• Create an artifact, such as a test report.
• Upload the artifact to cloud storage, such as S3.
• Use the Artifact Metadata Publisher plugin or S3 Upload and Publish plugin to publish the artifact URL on the Artifacts tab.

This tutorial demonstrates how to do this by creating a Harness CI pipeline that builds a Java Maven application and generates an Allure report that you can view in Harness.

Prerequisites

This tutorial assumes you have a CI pipeline with a Build stage.

If you haven't created a pipeline before, try Get started with the fastest CI or Build on a Kubernetes cluster before starting this tutorial.

Prepare cloud storage

1. You need access to one of the following cloud storage providers: S3, GCS, JFrog, or Sonatype Nexus.

   This tutorial uses GCS. If you use another option, you'll need to modify some of the steps according to your chosen cloud storage provider.

2. For S3, GCS, and JFrog, you must have a Harness connector to use with the Upload Artifact step:

   • S3: AWS connector
   • GCS: GCP connector
   • JFrog: Artifactory connector
   tip

   Store authentication and access keys for connectors as Harness secrets.

3. In your cloud storage, create a bucket or repo where you can upload your artifact.

   To access the artifact directly from the Artifacts tab, the upload location must be publicly available. If the location is not publicly available, you might need to log in to view the artifact or use an different artifact URL (such as a console view URL). This tutorial uses a publicly available GCS bucket to store the report.

Prepare artifacts to upload

Add steps to your pipeline that generate and prepare artifacts to upload, such as Run steps. The steps you use depend on what artifacts you ultimately want to upload.

For example, this tutorial uses three Run steps to generate and prepare an artifact:

• The first step runs tests with Maven.
• The second step generates an Allure report. To ensure the build environment has the Allure tool, the step uses a Docker image that has this tool: solutis/allure:2.9.0.
• The third step combines the Allure report into a single HTML file.
  • To view an Allure report in a browser, you must run a web server with the allure open command; however, this command won't persist after the CI pipeline ends. Instead, use the allure-combine tool to convert the Allure report into a single HTML file.
  • Running the allure-combine . command inside allure-report generates the complete.html file.
  • To ensure the build environment as access to the allure-combine tool, you can include steps to install it or use a Docker image that has the tool, such as shubham149/allure-combine:latest.

              - step:
                  type: Run
                  name: run maven tests
                  identifier: run_maven_tests
                  spec:
                    connectorRef: account.harnessImage
                    image: openjdk:11
                    shell: Sh
                    command: ./mvnw clean test site
              - step:
                  type: Run
                  name: generate allure report
                  identifier: generate_allure_report
                  spec:
                    connectorRef: account.harnessImage
                    image: solutis/allure:2.9.0
                    command: |
                      cd target
                      allure generate allure-results --clean -o allure-report
              - step:
                  type: Run
                  name: combine report
                  identifier: combine_report
                  spec:
                    connectorRef: account.harnessImage
                    image: shubham149/allure-combine:latest
                    command: |
                      cd target/allure-report
                      allure-combine .
                      cd ../..
                      cp target/allure-report/complete.html .

tip

For connectorRef, you can use the built-in Docker connector, account.harnessImage, or use your own Docker Hub connector.

Upload to cloud storage

Add a step to upload your artifact to cloud storage:

• Upload Artifacts to JFrog
• Upload Artifacts to GCS
• Upload Artifacts to S3
• Upload Artifacts to Sonatype Nexus

For example, this tutorial uploads the combined Allure report to GCS:

              - step:
                  type: GCSUpload
                  name: upload report
                  identifier: upload_report
                  spec:
                    connectorRef: YOUR_GCP_CONNECTOR_ID
                    bucket: YOUR_GCS_BUCKET
                    sourcePath: target/allure-report/complete.html
                    target: <+pipeline.sequenceId>

tip

The target value uses a Harness expression, <+pipeline.sequenceId>, to ensure that artifacts uploaded by this pipeline are stored in unique directories and don't overwrite one another.

View artifacts on the Artifacts tab

At this point, you can run the pipeline and then manually find the uploaded artifact in your cloud storage bucket or repo. Alternately, you can use a Drone plugin to publish the artifact URL to the Artifacts tab in Harness. This makes it easier to find the artifact directly associated with a particular build.

Artifact Metadata Publisher plugin

The Artifact Metadata Publisher plugin pulls content from cloud storage and publishes it to the Artifacts tab. You can use this plugin with any cloud storage provider.

To use this plugin, add a Plugin step after your upload artifact step.

For example, this step publishes the URL for the combined Allure report on GCS:

              - step:
                  type: Plugin
                  name: publish artifact metadata
                  identifier: publish_artifact_metadata
                  spec:
                    connectorRef: account.harnessImage
                    image: plugins/artifact-metadata-publisher
                    settings:
                      file_urls: https://storage.googleapis.com/YOUR_GCS_BUCKET/<+pipeline.sequenceId>/complete.html ## Provide the URL in your cloud storage bucket for the previously-uploaded artifact. If you uploaded multiple artifacts, you can provide a list of URLs.
                      artifact_file: artifact.txt ## Provide any '.txt' file name. Harness uses this to store the artifact URL and display it on the Artifacts tab. This value is not the name of your uploaded artifact, and it has no relationship to the artifact object itself.

info

For file_url, provide the URL to the artifact that uses the Bucket, Target, and artifact name specified in the Upload Artifacts step. The format depends on your cloud storage provider. For example:

• GCS: https://storage.googleapis.com/GCS_BUCKET_NAME/TARGET_PATH/ARTIFACT_NAME_WITH_EXTENSION
• S3: https://BUCKET.s3.REGION.amazonaws.com/TARGET/ARTIFACT_NAME_WITH_EXTENSION

The resolved value of file_urls is the URL that is published on the Artifacts tab. It is derived from the upload location specified in the Upload Artifact step.

For example, this tutorial uses https://storage.googleapis.com/YOUR_GCS_BUCKET/<+pipeline.sequenceId>/complete.html, which references the value of bucket, target, and artifact object name from the Upload Artifact step. When the pipeline runs, the expression <+pipeline.sequenceId> is resolved into a valid URL.

For private S3 buckets, use the console view URL, such as https://s3.console.aws.amazon.com/s3/object/BUCKET?region=REGION&prefix=TARGET/ARTIFACT_NAME_WITH_EXTENSION.

If you uploaded multiple artifacts, you can provide a list of URLs, such as:

                      file_urls:
                        - https://BUCKET.s3.REGION.amazonaws.com/TARGET/artifact1.html
                        - https://BUCKET.s3.REGION.amazonaws.com/TARGET/artifact2.txt

S3 Upload and Publish plugin

If you use S3 as your cloud storage provider, you can use the S3 Upload and Publish plugin to both upload your artifact and publish the URL to the Artifacts tab.

If you use this plugin, you do not need an Upload Artifacts to S3 step in your pipeline.

This plugin only supports S3.

Add a Plugin step that uses the drone-s3-upload-publish plugin, for example:

              - step:
                  type: Plugin
                  name: s3-upload-publish
                  identifier: custom_plugin
                  spec:
                    connectorRef: account.harnessImage
                    image: harnesscommunity/drone-s3-upload-publish
                    settings:
                     aws_access_key_id: <+pipeline.variables.AWS_ACCESS> ## Reference to your AWS access ID.
                      aws_secret_access_key: <+pipeline.variables.AWS_SECRET> ## Reference to your AWS access key.
                      aws_default_region: ap-southeast-2 ## Set to your default AWS region.
                      aws_bucket: BUCKET_NAME ## The target S3 bucket.
                      artifact_file: artifact.txt ## Provide any '.txt' file name. Harness uses this to store the artifact URL and display it on the Artifacts tab. This value is not the name of your uploaded artifact, and it has no relationship to the artifact object itself.
                      source: target/allure-report/complete.html ## Provide the path to the file or directory that you want to upload.
                      target: <+pipeline.sequenceId> ## Optional. Provide a path, relative to the 'aws_bucket', where you want to store the artifact. Do not include the bucket name. If unspecified, Harness uploads the artifact to the bucket's main directory.
                    imagePullPolicy: IfNotPresent

tip

For aws_access_key_id and aws_secret_access_key, use expressions to reference Harness secrets or pipeline variables that contain your AWS access ID and key.

This tutorial also uses an expression for the target: The expression <+pipeline.sequenceId> creates a directory based on the incremental build ID. This ensures that artifacts uploaded by this pipeline are stored in unique directories and don't overwrite one another.

If you want to upload a compressed file, you must use a Run step to compress the artifact before uploading it.

YAML examples

Harness Cloud

This example uses Harness Cloud build infrastructure and uploads the artifact to GCS.

pipeline:
  name: allure-report-upload
  identifier: allurereportupload
  projectIdentifier: YOUR_HARNESS_PROJECT_ID
  orgIdentifier: default
  tags: {}
  properties:
    ci:
      codebase:
        connectorRef: YOUR_CODEBASE_CONNECTOR_ID
        repoName: YOUR_CODE_REPO_NAME
        build: <+input>
  stages:
    - stage:
        name: test and upload artifact
        identifier: test_and_upload_artifact
        description: ""
        type: CI
        spec:
          cloneCodebase: true
          platform:
            os: Linux
            arch: Amd64
          runtime:
            type: Cloud
            spec: {}
          execution:
            steps:
              - step:
                  type: Run
                  name: run maven tests
                  identifier: run_maven_tests
                  spec:
                    connectorRef: account.harnessImage
                    image: openjdk:11
                    shell: Sh
                    command: ./mvnw clean test site
              - step:
                  type: Run
                  name: generate allure report
                  identifier: generate_allure_report
                  spec:
                    connectorRef: account.harnessImage
                    image: solutis/allure:2.9.0
                    command: |
                      cd target
                      allure generate allure-results --clean -o allure-report
              - step:
                  type: Run
                  name: combine report
                  identifier: combine_report
                  spec:
                    connectorRef: account.harnessImage
                    image: shubham149/allure-combine:latest
                    command: |
                      cd target/allure-report
                      allure-combine .
                      cd ../..
                      cp target/allure-report/complete.html .
              - step:
                  type: GCSUpload
                  name: upload report
                  identifier: upload_report
                  spec:
                    connectorRef: YOUR_GCP_CONNECTOR_ID
                    bucket: YOUR_GCS_BUCKET
                    sourcePath: target/allure-report/complete.html
                    target: <+pipeline.sequenceId>
              - step:
                  type: Plugin
                  name: publish artifact metadata
                  identifier: publish_artifact_metadata
                  spec:
                    connectorRef: account.harnessImage
                    image: plugins/artifact-metadata-publisher
                    settings:
                      file_urls: https://storage.googleapis.com/YOUR_GCS_BUCKET/<+pipeline.sequenceId>/complete.html
                      artifact_file: artifact.txt

Self-hosted

This example uses a Kubernetes cluster build infrastructure and uploads the artifact to GCS.

pipeline:
  name: allure-report-upload
  identifier: allurereportupload
  projectIdentifier: YOUR_HARNESS_PROJECT_ID
  orgIdentifier: default
  tags: {}
  properties:
    ci:
      codebase:
        connectorRef: YOUR_CODEBASE_CONNECTOR_ID
        repoName: YOUR_CODE_REPO_NAME
        build: <+input>
  stages:
    - stage:
        name: build
        identifier: build
        description: ""
        type: CI
        spec:
          cloneCodebase: true
          infrastructure:
            type: KubernetesDirect
            spec:
              connectorRef: YOUR_KUBERNETES_CLUSTER_CONNECTOR_ID
              namespace: YOUR_KUBERNETES_NAMESPACE
              automountServiceAccountToken: true
              nodeSelector: {}
              os: Linux
          execution:
            steps:
              - step:
                  type: Run
                  name: run maven tests
                  identifier: run_maven_tests
                  spec:
                    connectorRef: account.harnessImage
                    image: openjdk:11
                    shell: Sh
                    command: ./mvnw clean test site
              - step:
                  type: Run
                  name: generate allure report
                  identifier: generate_allure_report
                  spec:
                    connectorRef: account.harnessImage
                    image: solutis/allure:2.9.0
                    command: |
                      cd target
                      allure generate allure-results --clean -o allure-report
              - step:
                  type: Run
                  name: combine report
                  identifier: combine_report
                  spec:
                    connectorRef: account.harnessImage
                    image: shubham149/allure-combine:latest
                    command: |
                      cd target/allure-report
                      allure-combine .
                      cd ../..
                      cp target/allure-report/complete.html .
              - step:
                  type: GCSUpload
                  name: upload report
                  identifier: upload_report
                  spec:
                    connectorRef: YOUR_GCP_CONNECTOR_ID
                    bucket: YOUR_GCS_BUCKET
                    sourcePath: target/allure-report/complete.html
                    target: <+pipeline.sequenceId>
              - step:
                  type: Plugin
                  name: publish artifact metadata
                  identifier: publish_artifact_metadata
                  spec:
                    connectorRef: account.harnessImage
                    image: plugins/artifact-metadata-publisher
                    settings:
                      file_urls: https://storage.googleapis.com/YOUR_GCS_BUCKET/<+pipeline.sequenceId>/complete.html
                      artifact_file: artifact.txt