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

docs: add plugin docs #360

Merged
merged 8 commits into from
Oct 18, 2023
Merged

Conversation

sozercan
Copy link
Member

@sozercan sozercan commented Oct 9, 2023

Describe the changes in this pull request using active verbs such as Add, Remove, Replace ...

Closes #352

Signed-off-by: Sertac Ozercan <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
@sozercan sozercan marked this pull request as ready for review October 16, 2023 23:16
Comment on lines 21 to 28
# Community Scanner Plugins

If you have built a scanner plugin and would like to add it to this list, please submit a PR to update this section with your plugin.

:::tip

If you have any issues with a specific plugin, please open an issue in the applicable plugin's repository.

Copy link
Contributor

@anubhav06 anubhav06 Oct 17, 2023

Choose a reason for hiding this comment

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

We could add anubhav06/copa-grype to the list,
or I can open a PR to add it once this merges

Copy link
Member Author

Choose a reason for hiding this comment

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

added, thank you!

Signed-off-by: Sertac Ozercan <[email protected]>
@sozercan
Copy link
Member Author

/hold

```golang
type UpdateManifest struct {
// API version of the interface (e.g. v1alpha1)
APIVersion string `json:"apiVersion"`
Copy link
Contributor

Choose a reason for hiding this comment

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

should we add some verbiage about versioning, backward compatibility policy, etc?

Copy link
Member Author

Choose a reason for hiding this comment

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

added a note, let me know if you are looking for any specifics.

Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM


// Metadata contains information about the OS and config
type Metadata struct {
OS OS `json:"os"`
Copy link
Contributor

Choose a reason for hiding this comment

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

does copa validate against a supported list of OS and Arch?

Copy link
Contributor

@ritazh ritazh Oct 17, 2023

Choose a reason for hiding this comment

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

or do the non-supported ones just get skipped?

Copy link
Member Author

Choose a reason for hiding this comment

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

for OS, yes it'll validate and fail fast if it's not supported
for Arch, it's used for pulling the arch-specific image and vex output

Signed-off-by: Sertac Ozercan <[email protected]>
@sozercan sozercan requested a review from ritazh October 17, 2023 23:53
Copy link
Contributor

@ritazh ritazh left a comment

Choose a reason for hiding this comment

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

LGTM

@sozercan sozercan merged commit dd45fe1 into project-copacetic:main Oct 18, 2023
@sozercan sozercan deleted the docs-plugins branch October 18, 2023 01:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[DOC] add scanner plugin docs
4 participants