-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add SBOM and related checks to project #140
Conversation
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.
Is there a place to describe what these checks actually are? (sorry if i missed this)
Thanks @gwaybio - I added some comments to help better describe the check for the SBOM. All changes here pertain to the Almanack repo itself; we're adding an Eventually my hope would be to check for these files in other repos and make this a metric for the Almanack. The changes here were complex enough that I felt they should be standalone before an external-facing metric would be developed. |
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.
Neat; I wasn't aware that there were formal formats for SBOMs, so thanks for the opportunity to learn. I left a minor comment, but otherwise this all looks reasonable to me.
Thanks @falquaddoomi and @gwaybio for the reviews! Merging this in. |
Description
This PR adds a software bill of materials (SBOM) to the project using the SPDX convention. It also adds a pre-commit based check to ensure the
packages
section of the SBOM is up to date with any changes which have occurred in the source which could be reflected as a difference in the SBOM (meaning the SBOM will stay up to date so long as checks are passing).SBOM's are increasingly becoming commonplace to include within software projects and the use is also listed in RSMM framework (https://arxiv.org/pdf/2406.01788) under focus area 4 software adoptability, section 4.6 deployability as "the project has an SBOM".
This change is a first step towards following the convention and then checking for this convention in other work through the Almanack.
Closes #139
What is the nature of your change?
Checklist
Please ensure that all boxes are checked before indicating that this pull request is ready for review.