Skip to content

feat: generate unpruned gradle SBOM#5526

Closed
orsagie wants to merge 1 commit intomainfrom
feat/gradle-sbom-verbose
Closed

feat: generate unpruned gradle SBOM#5526
orsagie wants to merge 1 commit intomainfrom
feat/gradle-sbom-verbose

Conversation

@orsagie
Copy link
Copy Markdown
Contributor

@orsagie orsagie commented Oct 9, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

Upgrades the version of snyk-gradle-plugin used by the CLI.

The old version would prune any repeated dependency, but this is not the desired behaviour we want to see for SBOMs - when a customer requests an SBOM they should be getting the full graph (sans the cycles). This is what the new version does - maintains the old pruning behaviour for snyk test, but only prunes cycles for snyk sbom

Where should the reviewer start?

How should this be manually tested?

create a gradle project with:

plugins {
  id 'java'
}

repositories {
  mavenCentral()
}

dependencies {
   implementation 'org.apache.ignite:ignite-spring:2.13.0'
   implementation 'org.apache.ignite:ignite-indexing:2.13.0'
   implementation 'org.apache.ignite:ignite-core:2.13.0'
}
  • Old snyk sbom --format=cyclonedx1.4+json - will show pruned nodes
  • New snyk sbom --format=cyclonedx1.4+json - will not show pruned nodes

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@orsagie orsagie requested a review from a team as a code owner October 9, 2024 11:37
@orsagie orsagie force-pushed the feat/gradle-sbom-verbose branch from 8a85283 to fc6c371 Compare October 9, 2024 11:40
@orsagie orsagie requested a review from mcombuechen October 13, 2024 07:55
Copy link
Copy Markdown
Contributor

@mcombuechen mcombuechen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@orsagie do we have a fixture in this repo to replicate this with, i.e. add an acceptance test to show that we now see more dependencies when generating the sbom?

@github-actions
Copy link
Copy Markdown
Contributor

Your PR has not had any activity for 30 days. In 2 days I'll close it. Make some activity to remove this.

@github-actions github-actions Bot added the Stale label Mar 25, 2025
@github-actions
Copy link
Copy Markdown
Contributor

Your PR has now been stale for 2 days. I'm closing it.

@github-actions github-actions Bot closed this Mar 30, 2025
@github-actions github-actions Bot deleted the feat/gradle-sbom-verbose branch March 30, 2025 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants