-
Notifications
You must be signed in to change notification settings - Fork 6
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
Fix/empty SBOM #91
Fix/empty SBOM #91
Conversation
Signed-off-by: David Wertenteil <[email protected]>
Signed-off-by: David Wertenteil <[email protected]>
Signed-off-by: David Wertenteil <[email protected]>
Signed-off-by: David Wertenteil <[email protected]>
Signed-off-by: David Wertenteil <[email protected]>
PR Description updated to latest commit (bfae917) |
PR Analysis
PR Feedback💡 General suggestions: The PR seems to be well-structured and the changes are well-explained. However, it would be beneficial to include tests to verify the new changes, especially the handling of init containers and the updated metadata keys. 🤖 Code feedback:
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
Summary:
|
User description
Sorry, we do not accept changes directly against this repository. Please see
CONTRIBUTING.md for information on where and how to contribute instead.
Type
Bug fix, Enhancement
Description
This PR includes several bug fixes and enhancements:
unpackSrcMetadata
function inpkg/apis/softwarecomposition/syfttypes.go
.instanceidhandler
withhelpersv1
for accessing various metadata keys inpkg/cleanup/cleanup.go
.pkg/cleanup/discovery.go
, allowing the system to handle init containers in addition to regular containers.pkg/generated/openapi/zz_generated.openapi.go
. ThepolicyRef
field is no longer required forGeneratedNetworkPolicy
, and therelevant
field is no longer required forVulnerabilitiesComponents
andVulnerabilityCounters
.kubescape/k8s-interface
package fromv0.0.154
tov0.0.158-0.20240117162237-b087cd69bcf1
ingo.mod
andgo.sum
.Changes walkthrough
syfttypes.go
pkg/apis/softwarecomposition/syfttypes.go
Added a condition to return nil when the type is not set in
the
unpackSrcMetadata
function. This handles cases wherethe object returned from the watcher does not have the type
set.
zz_generated.openapi.go
pkg/generated/openapi/zz_generated.openapi.go
Updated the required fields for several schemas. The
policyRef
field is no longer required forGeneratedNetworkPolicy
, and therelevant
field is nolonger required for
VulnerabilitiesComponents
andVulnerabilityCounters
.cleanup.go
pkg/cleanup/cleanup.go
Replaced the usage of
instanceidhandler
withhelpersv1
for accessing various metadata keys. This change is
reflected in multiple functions within the file.
discovery.go
pkg/cleanup/discovery.go
Added support for init containers in the
fetchWlidsFromRunningWorkloads
andfetchInstanceIdsAndImageIdsAndReplicasFromRunningPods
functions. This allows the system to handle init containers
in addition to regular containers.
go.mod
go.mod
Updated the version of the
kubescape/k8s-interface
packagefrom
v0.0.154
tov0.0.158-0.20240117162237-b087cd69bcf1
.go.sum
go.sum
Updated the checksums for the
kubescape/k8s-interface
package to reflect the version update in
go.mod
.✨ Usage guide:
Overview:
The
describe
tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.When commenting, to edit configurations related to the describe tool (
pr_description
section), use the following template:With a configuration file, use the following template:
Enabling\disabling automation
meaning the
describe
tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.the tool will replace every marker of the form
pr_agent:marker_name
in the PR description with the relevant content, wheremarker_name
is one of the following:type
: the PR type.summary
: the PR summary.walkthrough
: the PR walkthrough.Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the
describe
tool are quite generic: [Bug fix
,Tests
,Enhancement
,Documentation
,Other
].If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:
Main topic:performance
- pr_agent:The main topic of this PR is performanceNew endpoint
- pr_agent:A new endpoint was added in this PRSQL query
- pr_agent:A new SQL query was added in this PRDockerfile changes
- pr_agent:The PR contains changes in the DockerfileThe list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Utilizing extra instructions
The
describe
tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.