-
Notifications
You must be signed in to change notification settings - Fork 22
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
Improve the generated template README #224
Conversation
Signed-off-by: Guilherme Macedo <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
thanks
@@ -47,21 +47,22 @@ const ( | |||
"`vexctl generate` when generating VEX data for a release or\n" + | |||
"a specific artifact.\n\n" + | |||
"To add new statements to publish data about a vulnerability,\n" + | |||
"download [vexctl](https://github.com/openvex/vexctl)\n" + | |||
"and append new statements using `vexctl add`. For example:\n\n" + | |||
"download [vexctl] and append new statements using\n" + |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah sorry
i think you can keep the link
"download [vexctl] and append new statements using\n" + | |
"download [vexctl](https://github.com/openvex/vexctl) and append new statements using\n" + |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The auto generated template will be like this, because it uses the shortcut reference link.
OpenVEX Templates Directory
This directory contains the OpenVEX data for this repository.
The files stored in this directory are used as templates by
vexctl generate
when generating VEX data for a release or
a specific artifact.
To add new statements to publish data about a vulnerability,
download vexctl and append new statements using
vexctl add
. For example:
vexctl add --in-place main.openvex.json --product pkg:oci/test --vuln CVE-2014-1234567 --status under_investigation
That will add a new VEX statement expressing that the impact of
CVE-2014-1234567 is under investigation in the test image. When
cutting a new release, for pkg:oci/test
the new file can be
incorporated to the release's VEX data.
Read more about OpenVEX
To know more about generating, publishing and using VEX data
in your project, please check out the vexctl repository and
documentation.
OpenVEX also has an examples repository with samples and docs.
We use the same shortcut in both references to vexctl
, because the original target link is the same.
thanks |
Small suggestion to improve the generated template README with:
fixed
, but the textunder investigation
.Before
After