- [Jenkins Shared Library](#jenkins-shared-library)
  - [Detecting Docker Agent](#detecting-docker-agent)
  - [All-In-One Build](#all-in-one-build)
  - [Cross-Platform Build](#cross-platform-build)
  - [Building Docker Images](#building-docker-images)
  - [Avoiding Rebuilding](#avoiding-rebuilding)
  - [Publishing Notifications](#publishing-notifications)
  - [Cleanup](#cleanup)
  - [Running Integration Tests](#running-integration-tests)
  - [Uploading Test Results](#uploading-test-results)

## Jenkins Shared Library

The Jenkins shared library implements common functions used by [Jenkins workflows](../jenkins) in this repository.

### Detecting Docker Agent

OpenSearch and OpenSearch Dashboards manifests contain a `ci` section with the docker image to use for building the manifest. This is loaded and published from [detectDockerAgent](./detectDockerAgent.groovy) to be used as `agent` arguments.

### All-In-One Build

A typical all-in-one build consists of [build](./buildManifest.groovy), [assemble](./assembleManifest.groovy) and [upload](./uploadArtifacts.groovy), implemented in [buildAssembleUpload.groovy](./buildAssembleUpload.groovy).

### Cross-Platform Build

A cross platform build divides the all-in-one build into steps that can be executed across multiple stages. For example, OpenSearch dashboards builds on an x64 docker image, but assembles on an arm64 docker image for an arm64 build.  

1. [buildArchive](./buildArchive.groovy) generates a manifest lock, calculates its SHA using [getManifestSHA](./getManifestSHA.groovy), and checks against previously built artifacts, before building and archiving the output to be used in a subsequent step. 
2. [archiveAssembleUpload](./archiveAssembleUpload.groovy) extracts previously archived build output and manifest lock, assembles a distribution and uploads it. 

### Building Docker Images

See [buildDockerImage](./buildDockerImage.groovy).

### Avoiding Rebuilding
A [SHA of the manifest lock](../src/build_workflow/README.md#avoiding-rebuilds) can be generated using [getManifestSHA](./getManifestSHA.groovy), and checking it against previously published artifacts.  If a build is consider released, its manifest SHA can be uploaded with [buildUploadManifestSHA](./buildUploadManifestSHA.groovy).


### Publishing Notifications

See [publishNotification](./publishNotification.groovy).

### Cleanup 

See [postCleanup](./postCleanup.groovy).

### Running Integration Tests

See [runIntegTestScript](./runIntegTestScript.groovy).

### Uploading Test Results

See [uploadTestResults](./uploadTestResults.groovy).