Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding sbom_generation.yml for enabling vulnerability scan by GCAS tool #454

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions sbom_generation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.

# 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
env:
variables:
PYTHON_CMD: "python3"
CDXGEN_DEBUG_MODE: "debug"
steps:
- type: Command
name: "Download the version 10.10.0 of cdxgen globally"
command: |
npm install -g @cyclonedx/[email protected]
- type: Command
name: "Workaround to let cdxgen run on nodejs 16"
command: |
# cdxgen relies on a fourth-party dependency that cannot be executed in a Node.js environment running version 16
# (as installed on the build runner instance)
# This is a workaround to ensure cdxgen functions correctly, even in an older Node.js environment.
cd /node/node-v16.14.2-linux-x64/lib/node_modules/@cyclonedx/cdxgen && \
npm install [email protected]
- type: Command
name: "Generate SBOM for Python "
command: |
# Search the test or dev requirements files, so that test and dev py packages can be excluded in the generated SBOM
files=$(find . -type f -regex ".*\(test.*requirements\|requirements.*test\|dev.*requirements\|requirements.*dev\).*\.txt") && \
if [ -n "$files" ]; then \
cdxgen -t python -o artifactSBOM.json --spec-version 1.4 \
--exclude "*{requirements,dev,test}*{requirements,dev,test}*.txt" --project-name "$(basename $OCI_PRIMARY_SOURCE_URL)" --no-recurse
else \
cdxgen -t python -o artifactSBOM.json --spec-version 1.4 --project-name "$(basename $OCI_PRIMARY_SOURCE_URL)" --no-recurse
fi \
outputArtifacts:
- name: artifactSBOM
type: BINARY
location: ${OCI_PRIMARY_SOURCE_DIR}/artifactSBOM.json