Skip to content

Commit

Permalink
Initialize the VEX feed
Browse files Browse the repository at this point in the history
Signed-off-by: Ricardo Lopes <ricardoapl.dev@gmail.com>
  • Loading branch information
ricardoapl committed May 21, 2024
1 parent cb1b979 commit 7d848fb
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .openvex/templates/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# 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](https://github.com/openvex/vexctl)
and append new statements using `vexctl add`. For example:
```
vexctl add --in-place main.openvex.json pkg:oci/test CVE-2014-1234567 fixed
```
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 will be
incorporated to the relase'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: https://github.com/openvex/vexctl

OpenVEX also has an examples repository with samples and docs:
https://github.com/openvex/examples

8 changes: 8 additions & 0 deletions .openvex/templates/main.openvex.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"@context": "https://openvex.dev/ns/v0.2.0",
"@id": "https://openvex.dev/docs/public/vex-ac6818e9628eb70212cce0c7c636dcc04e554c843b12fd9c35be87496ccf5981",
"author": "vexctl (automated template)",
"timestamp": "2024-05-21T20:39:00.38997+01:00",
"version": 1,
"statements": []
}

0 comments on commit 7d848fb

Please sign in to comment.