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

refactor: move PkgRef under PkgIdentifier #5831

Merged
merged 3 commits into from
Dec 29, 2023

Conversation

knqyf263
Copy link
Collaborator

@knqyf263 knqyf263 commented Dec 27, 2023

Description

PkgRef stores package identifiers, like BOM-Ref and PURL, in SBOM. Since #5439 added a new field Identifier for PURL, PkgRef should be moved under the new field. PkgRef can have both BOM-Ref and PURL, but PURL already has a dedicated field under Identifier. Therefore, this PR adds a new field for BOM-Ref.

PkgRef is for internal use, so we believe it won't break anything, but it is exported in JSON and people can rely on the field. We'd announce it just in case.

Related PRs

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

Signed-off-by: knqyf263 <knqyf263@gmail.com>
@knqyf263 knqyf263 self-assigned this Dec 27, 2023
Signed-off-by: knqyf263 <knqyf263@gmail.com>
@knqyf263 knqyf263 marked this pull request as ready for review December 28, 2023 18:12
Copy link
Contributor

@DmitriyLewen DmitriyLewen left a comment

Choose a reason for hiding this comment

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

LGTM

@knqyf263 knqyf263 added this pull request to the merge queue Dec 29, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 29, 2023
@knqyf263 knqyf263 added this pull request to the merge queue Dec 29, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 29, 2023
Signed-off-by: knqyf263 <knqyf263@gmail.com>
@knqyf263 knqyf263 added this pull request to the merge queue Dec 29, 2023
Merged via the queue into aquasecurity:main with commit 1607eee Dec 29, 2023
12 checks passed
@knqyf263 knqyf263 deleted the refactor/pkg_ref branch December 29, 2023 07:12
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