Skip to content

Commit

Permalink
fixup! lockfile is versioned
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Koscielniak <[email protected]>
  • Loading branch information
kosciCZ committed Sep 20, 2024
1 parent 5d3fd7c commit 2ceeaa7
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/design/generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@ of the fetched artifacts. This decision was made mainly because it allows for fo
with accurate SBOM information. Alternatively, for better user experience, the download url and checksums can be specified
separately, always resulting in a `pkg:generic` purl. Here's an example of such a lockfile with both options.

In order to account for possible future breaking changes, the lockfile will contain a `metadata` section with a `version`
field that will indicate the version of the lockfile format.

```yaml
metadata:
version: 1.0.0
artifacts:
- purl: pkg:generic/granite-model?download_url=https://huggingface.co/instructlab/granite-7b-lab/resolve/main/model-00001-of-00003.safetensors?download=true
target: granite-model-1.safetensors
Expand Down

0 comments on commit 2ceeaa7

Please sign in to comment.