From ae6b2585e5f68441e61f40bb7d1503ff8d8474e7 Mon Sep 17 00:00:00 2001 From: Stefan Prodan Date: Sat, 21 Oct 2023 21:34:20 +0300 Subject: [PATCH] Document how to update the CUE schemas Signed-off-by: Stefan Prodan --- schemas/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 schemas/README.md diff --git a/schemas/README.md b/schemas/README.md new file mode 100644 index 00000000..9b140a0b --- /dev/null +++ b/schemas/README.md @@ -0,0 +1,23 @@ +# Timoni CUE Schemas + +The Timoni's CUE schemas are included in the modules generated with `timoni mod init`. + +## Vendoring + +To update a module's schemas to the latest version, +run the following command from within the module root: + +```shell +timoni artifact pull oci://ghcr.io/stefanprodan/timoni/schemas:latest \ + --output cue.mod/pkg +``` + +To update the schemas and verify the signature with Cosign v2: + +```shell +timoni artifact pull oci://ghcr.io/stefanprodan/timoni/schemas:latest \ + --verify=cosign \ + --certificate-identity-regexp="^https://github.com/stefanprodan/timoni.*$" \ + --certificate-oidc-issuer=https://token.actions.githubusercontent.com \ + --output cue.mod/pkg +```