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

Add id to submitSnapshot success response #117

Conversation

gitulisca
Copy link
Contributor

Purpose

This change will add the Snapshot id returned by Dependency Graph when a Snapshot is successfully submitted.

The Snapshot id is useful information to have when troubleshooting Dependency Graph issues as it facilitates the correlation of workflow run (or job) with a particular Snapshot reported in Dependency Graph.

It will also help GitHub Support Engineers to verify whether the canonical Snapshot reporting in our Internal Tooling matches the workflow run discussed in the support tickets.

The expected outcome is that the additional Snapshot Id will be written to workflow run log and summary when actions that leverage the dependency submission toolkit are used. For example, the advanced-security/maven-dependency-submission-action and advanced-security/component-detection-dependency-submission-action actions.

Related Issues

What issues does this PR close or relate to?

N/A


  • Confirmed that tests are passing locally.
  • Triggered a workflow run with the Example Dependency Submission Action to confirm the desired output

sample-updated-output-2
sample-updated-output

@Copilot Copilot bot review requested due to automatic review settings April 4, 2025 03:47
@gitulisca gitulisca requested a review from a team as a code owner April 4, 2025 03:47
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds the Snapshot id to the success response message when a snapshot is created, providing more useful information for troubleshooting in workflow run logs and summaries.

  • Updated the success notice message in submitSnapshot to include the Snapshot id.
  • Helps correlate Dependency Graph snapshots with workflow runs and support tickets.

Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more

Copy link
Contributor

@ljones140 ljones140 left a comment

Choose a reason for hiding this comment

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

Looks good

@gitulisca gitulisca merged commit 7c5d0f2 into github:main Apr 4, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants