-
Notifications
You must be signed in to change notification settings - Fork 23
Add on-demand SBOM generation workflow #191
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
Open
Lukasz-Juranek
wants to merge
1
commit into
eclipse-score:main
Choose a base branch
from
Lukasz-Juranek:feat/sbom-generation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,353
−44
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
| # SBOM Generation Workflow | ||
| # | ||
| # Summary: | ||
| # Generates a Software Bill of Materials (SPDX 2.3 + CycloneDX 1.6) for the | ||
| # core showcase Bazel targets and stores the results as a GitHub Actions | ||
| # artifact. Submits the SPDX snapshot to the GitHub Dependency Submission API | ||
| # to enable Dependabot vulnerability alerts. | ||
| # | ||
| # Triggers: | ||
| # - workflow_dispatch (on-demand only) | ||
| # | ||
| # Outputs: | ||
| # - Artifact "sbom-<sha>": reference_integration_sbom.spdx.json + | ||
| # reference_integration_sbom.cdx.json (retained 90 days) | ||
| # - GitHub Dependency Graph snapshot (enables Dependabot alerts per commit) | ||
| # | ||
| # Covered targets: | ||
| # - //showcases/cli:cli | ||
| # - //showcases/orchestration_persistency:orch_per_example | ||
| name: Generate SBOM | ||
| on: | ||
| workflow_dispatch: | ||
| jobs: | ||
| sbom: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write # required for GitHub Dependency Submission API | ||
| steps: | ||
| - name: Clean disk space | ||
| uses: eclipse-score/more-disk-space@v1 | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4.2.2 | ||
| - name: Setup Bazel | ||
| uses: bazel-contrib/setup-bazel@0.18.0 | ||
| with: | ||
| bazelisk-cache: true | ||
| disk-cache: ${{ github.workflow }} | ||
| repository-cache: true | ||
| cache-save: true | ||
| - name: Install uv | ||
| uses: astral-sh/setup-uv@v7.6.0 | ||
| - name: Install Java for Rust crate metadata | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y --no-install-recommends openjdk-11-jre-headless | ||
| - name: Build SBOM | ||
| run: bazel build --lockfile_mode=error //:reference_integration_sbom | ||
| - name: Upload SBOM artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: sbom-${{ github.sha }} | ||
| path: | | ||
| bazel-bin/reference_integration_sbom.spdx.json | ||
| bazel-bin/reference_integration_sbom.cdx.json | ||
| retention-days: 90 | ||
| - name: Convert SPDX to GitHub Dependency snapshot | ||
| run: | | ||
| bazel run @score_sbom//scripts:spdx_to_github_snapshot_bin -- \ | ||
| --input "$GITHUB_WORKSPACE/bazel-bin/reference_integration_sbom.spdx.json" \ | ||
| --output "$GITHUB_WORKSPACE/snapshot.json" \ | ||
| --sha "${{ github.sha }}" \ | ||
| --ref "${{ github.ref }}" \ | ||
| --job-correlator "generate-sbom" \ | ||
| --job-id "${{ github.run_id }}" | ||
| - name: Submit to GitHub Dependency Submission API | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| script: | | ||
| const fs = require('fs'); | ||
| const snapshot = JSON.parse(fs.readFileSync(process.env.GITHUB_WORKSPACE + '/snapshot.json', 'utf8')); | ||
| await github.rest.dependencyGraph.createRepositorySnapshot({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| ...snapshot, | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,7 @@ | |
| # ******************************************************************************* | ||
|
|
||
| load("@score_docs_as_code//:docs.bzl", "docs") | ||
| load("@score_sbom//:defs.bzl", "sbom") | ||
| load("@score_tooling//:defs.bzl", "copyright_checker", "setup_starpls", "use_format_targets") | ||
|
|
||
| # Docs-as-code | ||
|
|
@@ -69,3 +70,15 @@ exports_files([ | |
| "MODULE.bazel", | ||
| "pyproject.toml", | ||
| ]) | ||
|
|
||
| # SBOM for core showcase targets | ||
| sbom( | ||
| name = "reference_integration_sbom", | ||
| auto_crates_cache = True, | ||
| component_name = "score_reference_integration", | ||
| module_lockfiles = [":MODULE.bazel.lock"], | ||
| targets = [ | ||
| "//showcases/cli:cli", | ||
| "//showcases/orchestration_persistency:orch_per_example", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does not sounds like what you mostly want to shall do. Guess we shall check all incoming modules mainaly or ? |
||
| ], | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please explain what is happing here and why.