sbom_generation.yaml

#
# Copyright (c) 2023, 2025 Oracle and/or its affiliates.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# This OCI DevOps build specification file [1] generates a Software Bill of Materials (SBOM) of the repository.
# The file is needed to run checks for third-party vulnerabilities and business approval according to Oracle’s GitHub policies.
# [1] https://docs.oracle.com/en-us/iaas/Content/devops/using/build_specs.htm

version: 0.1
component: build
timeoutInSeconds: 1000
shell: bash

steps:
  - type: Command
    name: "Run Maven cycloneDX plugin command"
    command: |
      # For more details, visit https://github.com/CycloneDX/cyclonedx-maven-plugin/blob/master/README.md
      mvn org.cyclonedx:cyclonedx-maven-plugin:2.9.1:makeAggregateBom \
        -DincludeRuntimeScope=true \
        -DincludeCompileScope=true \
        -DincludeProvidedScope=false \
        -DincludeSystemScope=false \
        -DincludeTestScope=false \
        -DoutputFormat=json \
        -DoutputName=artifactSBOM \
        -DschemaVersion=1.4
      mv target/artifactSBOM.json ${OCI_PRIMARY_SOURCE_DIR}/artifactSBOM.json
outputArtifacts:
  - name: artifactSBOM
    type: BINARY
    location: ${OCI_PRIMARY_SOURCE_DIR}/artifactSBOM.json