Skip to content

Commit

Permalink
Add documentation about Alpine type (#697)
Browse files Browse the repository at this point in the history
Signed-off-by: John Speed Meyers <jsmeyers@chainguard.dev>
  • Loading branch information
jspeed-meyers authored Mar 2, 2022
1 parent cdccb6c commit f6d2d81
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions pkg/types/alpine/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**Alpine Type Data Documentation**

This document notes additional information (beyond that found in the Alpine schema) about the values associated with
each field such as the format in which the data is stored and any necessary transformations.

Further information about pkginfo fields and the .PKGINFO file can be found on the [Alpine documentation website](https://wiki.alpinelinux.org/wiki/Alpine_package_format#.PKGINFO).

The value of the `publicKey` `content` field ought to be Base64-encoded.

**How do you identify an object as an Alpine object?**

The "Body" field will include an "AlpineModel" field.

0 comments on commit f6d2d81

Please sign in to comment.