From 9b0590dd535a6638cf4f99997197352c734a3667 Mon Sep 17 00:00:00 2001 From: Billy Lynch Date: Mon, 20 Nov 2023 12:44:30 -0500 Subject: [PATCH] Add jsonschema generation binary. Mirrors https://github.com/chainguard-dev/apko/pull/964 for melange config types. Signed-off-by: Billy Lynch --- go.mod | 4 + go.sum | 8 + internal/gen-jsonschema/generate.go | 16 + internal/gen-jsonschema/main.go | 39 ++ pkg/config/config.go | 2 +- pkg/config/schema.json | 985 ++++++++++++++++++++++++++++ 6 files changed, 1053 insertions(+), 1 deletion(-) create mode 100644 internal/gen-jsonschema/generate.go create mode 100644 internal/gen-jsonschema/main.go create mode 100644 pkg/config/schema.json diff --git a/go.mod b/go.mod index 58cec45f5..25e2e2a23 100644 --- a/go.mod +++ b/go.mod @@ -20,6 +20,7 @@ require ( github.com/google/go-github/v54 v54.0.0 github.com/ijt/goparsify v0.0.0-20221203142333-3a5276334b8d github.com/imdario/mergo v0.3.16 + github.com/invopop/jsonschema v0.12.0 github.com/joho/godotenv v1.5.1 github.com/kelseyhightower/envconfig v1.4.0 github.com/klauspost/compress v1.17.2 @@ -66,6 +67,8 @@ require ( github.com/ProtonMail/go-crypto v0.0.0-20230923063757-afb1ddc0824c // indirect github.com/acomagu/bufpipe v1.0.4 // indirect github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect + github.com/bahlo/generic-list-go v0.2.0 // indirect + github.com/buger/jsonparser v1.1.1 // indirect github.com/cloudflare/circl v1.3.6 // indirect github.com/common-nighthawk/go-figure v0.0.0-20210622060536-734e95fb86be // indirect github.com/containerd/containerd v1.7.7 // indirect @@ -152,6 +155,7 @@ require ( github.com/titanous/rocacheck v0.0.0-20171023193734-afe73141d399 // indirect github.com/vbatts/tar-split v0.11.5 // indirect github.com/whilp/git-urls v1.0.0 // indirect + github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect github.com/xanzy/ssh-agent v0.3.3 // indirect github.com/xorcare/pointer v1.2.2 // indirect go.lsp.dev/uri v0.3.0 // indirect diff --git a/go.sum b/go.sum index e48e5c3bc..9b47243f7 100644 --- a/go.sum +++ b/go.sum @@ -72,8 +72,12 @@ github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkY github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw= github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 h1:DklsrG3dyBCFEj5IhUbnKptjxatkF07cF2ak3yi77so= github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw= +github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPnH1Wvgk= +github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= +github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs= +github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0= github.com/bwesterb/go-ristretto v1.2.3/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0= github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44= @@ -372,6 +376,8 @@ github.com/imdario/mergo v0.3.16/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+h github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/invopop/jsonschema v0.12.0 h1:6ovsNSuvn9wEQVOyc72aycBMVQFKz7cPdMJn10CvzRI= +github.com/invopop/jsonschema v0.12.0/go.mod h1:ffZ5Km5SWWRAIN6wbDXItl95euhFz2uON45H2qjYt+0= github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= github.com/jinzhu/copier v0.4.0 h1:w3ciUoD19shMCRargcpm0cm91ytaBhDvuRpz1ODO/U8= @@ -571,6 +577,8 @@ github.com/vbatts/tar-split v0.11.5 h1:3bHCTIheBm1qFTcgh9oPu+nNBtX+XJIupG/vacinC github.com/vbatts/tar-split v0.11.5/go.mod h1:yZbwRsSeGjusneWgA781EKej9HF8vme8okylkAeNKLk= github.com/whilp/git-urls v1.0.0 h1:95f6UMWN5FKW71ECsXRUd3FVYiXdrE7aX4NZKcPmIjU= github.com/whilp/git-urls v1.0.0/go.mod h1:J16SAmobsqc3Qcy98brfl5f5+e0clUvg1krgwk/qCfE= +github.com/wk8/go-ordered-map/v2 v2.1.8 h1:5h/BUHu93oj4gIdvHHHGsScSTMijfx5PeYkE/fJgbpc= +github.com/wk8/go-ordered-map/v2 v2.1.8/go.mod h1:5nJHM5DyteebpVlHnWMV0rPz6Zp7+xBAnxjb1X5vnTw= github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI= diff --git a/internal/gen-jsonschema/generate.go b/internal/gen-jsonschema/generate.go new file mode 100644 index 000000000..53be37afd --- /dev/null +++ b/internal/gen-jsonschema/generate.go @@ -0,0 +1,16 @@ +// Copyright 2023 Chainguard, Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +//go:generate go run . -o ../../pkg/config/schema.json +package main diff --git a/internal/gen-jsonschema/main.go b/internal/gen-jsonschema/main.go new file mode 100644 index 000000000..f0dbb025e --- /dev/null +++ b/internal/gen-jsonschema/main.go @@ -0,0 +1,39 @@ +package main + +import ( + "bytes" + "encoding/json" + "flag" + "log" + "os" + + "chainguard.dev/melange/pkg/config" + "github.com/invopop/jsonschema" +) + +var ( + outputFlag = flag.String("o", "", "output path") +) + +func main() { + flag.Parse() + + if *outputFlag == "" { + log.Fatal("output path is required") + } + + r := new(jsonschema.Reflector) + if err := r.AddGoComments("chainguard.dev/melange/pkg/build", "../../pkg/config"); err != nil { + log.Fatal(err) + } + schema := r.Reflect(config.Configuration{}) + b := new(bytes.Buffer) + enc := json.NewEncoder(b) + enc.SetIndent("", " ") + if err := enc.Encode(schema); err != nil { + log.Fatal(err) + } + if err := os.WriteFile(*outputFlag, b.Bytes(), 0644); err != nil { + log.Fatal(err) + } +} diff --git a/pkg/config/config.go b/pkg/config/config.go index 9e7dd2f4b..ee9118645 100644 --- a/pkg/config/config.go +++ b/pkg/config/config.go @@ -341,7 +341,7 @@ type Configuration struct { // Package metadata Package Package `json:"package" yaml:"package"` // The specification for the packages build environment - Environment apko_types.ImageConfiguration + Environment apko_types.ImageConfiguration `json:"environment" yaml:"environment"` // Required: The list of pipelines that produce the package. Pipeline []Pipeline `json:"pipeline,omitempty" yaml:"pipeline,omitempty"` // Optional: The list of subpackages that this package also produces. diff --git a/pkg/config/schema.json b/pkg/config/schema.json new file mode 100644 index 000000000..3adbe2c40 --- /dev/null +++ b/pkg/config/schema.json @@ -0,0 +1,985 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://chainguard.dev/melange/pkg/config/configuration", + "$ref": "#/$defs/Configuration", + "$defs": { + "AccountsOption": { + "properties": { + "RunAs": { + "type": "string" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "RunAs" + ] + }, + "BuildOption": { + "properties": { + "Contents": { + "$ref": "#/$defs/ContentsOption" + }, + "Accounts": { + "$ref": "#/$defs/AccountsOption" + }, + "Environment": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "Entrypoint": { + "$ref": "#/$defs/ImageEntrypoint" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Contents", + "Accounts", + "Environment", + "Entrypoint" + ] + }, + "Checks": { + "properties": { + "enabled": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Optional: enable these linters that are not enabled by default." + }, + "disabled": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Optional: disable these linters that are not enabled by default." + } + }, + "additionalProperties": false, + "type": "object" + }, + "Configuration": { + "properties": { + "package": { + "$ref": "#/$defs/Package", + "description": "Package metadata" + }, + "environment": { + "$ref": "#/$defs/ImageConfiguration", + "description": "The specification for the packages build environment" + }, + "pipeline": { + "items": { + "$ref": "#/$defs/Pipeline" + }, + "type": "array", + "description": "Required: The list of pipelines that produce the package." + }, + "subpackages": { + "items": { + "$ref": "#/$defs/Subpackage" + }, + "type": "array", + "description": "Optional: The list of subpackages that this package also produces." + }, + "data": { + "items": { + "$ref": "#/$defs/RangeData" + }, + "type": "array", + "description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline" + }, + "update": { + "$ref": "#/$defs/Update", + "description": "Optional: The update block determining how this package is auto updated" + }, + "vars": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline" + }, + "var-transforms": { + "items": { + "$ref": "#/$defs/VarTransforms" + }, + "type": "array", + "description": "Optional: A list of transformations to create for the builtin template\nvariables" + }, + "options": { + "additionalProperties": { + "$ref": "#/$defs/BuildOption" + }, + "type": "object", + "description": "Optional: Deviations to the build" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "package", + "environment" + ], + "description": "The root melange configuration" + }, + "ContentsOption": { + "properties": { + "Packages": { + "$ref": "#/$defs/ListOption" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Packages" + ] + }, + "Copyright": { + "properties": { + "paths": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Optional: The license paths, typically '*'" + }, + "attestation": { + "type": "string", + "description": "Optional: Attestations of the license" + }, + "license": { + "type": "string", + "description": "Required: The license for this package" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "license" + ] + }, + "DataItems": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "Dependencies": { + "properties": { + "runtime": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Optional: List of runtime dependencies" + }, + "provides": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Optional: List of packages provided" + }, + "replaces": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Optional: List of replace objectives" + }, + "provider-priority": { + "type": "integer", + "description": "Optional: An integer compared against other equal package provides used to\ndetermine priority" + } + }, + "additionalProperties": false, + "type": "object" + }, + "GitHubMonitor": { + "properties": { + "identifier": { + "type": "string", + "description": "Org/repo for GitHub" + }, + "strip-prefix": { + "type": "string", + "description": "If the version in GitHub contains a prefix which should be ignored" + }, + "strip-suffix": { + "type": "string", + "description": "If the version in GitHub contains a suffix which should be ignored" + }, + "tag-filter": { + "type": "string", + "description": "Filter to apply when searching tags on a GitHub repository" + }, + "use-tag": { + "type": "boolean", + "description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "identifier" + ], + "description": "GitHubMonitor indicates using the GitHub API" + }, + "Group": { + "properties": { + "GroupName": { + "type": "string" + }, + "GID": { + "type": "integer" + }, + "Members": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "GroupName", + "GID", + "Members" + ] + }, + "ImageAccounts": { + "properties": { + "RunAs": { + "type": "string" + }, + "Users": { + "items": { + "$ref": "#/$defs/User" + }, + "type": "array" + }, + "Groups": { + "items": { + "$ref": "#/$defs/Group" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "RunAs", + "Users", + "Groups" + ] + }, + "ImageConfiguration": { + "properties": { + "Contents": { + "$ref": "#/$defs/ImageContents" + }, + "Entrypoint": { + "$ref": "#/$defs/ImageEntrypoint" + }, + "Cmd": { + "type": "string" + }, + "StopSignal": { + "type": "string" + }, + "WorkDir": { + "type": "string" + }, + "Accounts": { + "$ref": "#/$defs/ImageAccounts" + }, + "Archs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Environment": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "Paths": { + "items": { + "$ref": "#/$defs/PathMutation" + }, + "type": "array" + }, + "OSRelease": { + "$ref": "#/$defs/OSRelease" + }, + "VCSUrl": { + "type": "string" + }, + "Annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "Include": { + "type": "string" + }, + "Options": { + "additionalProperties": { + "$ref": "#/$defs/BuildOption" + }, + "type": "object" + }, + "Volumes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Contents", + "Entrypoint", + "Cmd", + "StopSignal", + "WorkDir", + "Accounts", + "Archs", + "Environment", + "Paths", + "OSRelease", + "VCSUrl", + "Annotations", + "Include", + "Options", + "Volumes" + ] + }, + "ImageContents": { + "properties": { + "Repositories": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Keyring": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Packages": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Repositories", + "Keyring", + "Packages" + ] + }, + "ImageEntrypoint": { + "properties": { + "Type": { + "type": "string" + }, + "Command": { + "type": "string" + }, + "ShellFragment": { + "type": "string" + }, + "Services": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Type", + "Command", + "ShellFragment", + "Services" + ] + }, + "Input": { + "properties": { + "description": { + "type": "string", + "description": "Optional: The human readable description of the input" + }, + "default": { + "type": "string", + "description": "Optional: The default value of the input. Required when the input is." + }, + "required": { + "type": "boolean", + "description": "Optional: A toggle denoting whether the input is required or not" + } + }, + "additionalProperties": false, + "type": "object" + }, + "ListOption": { + "properties": { + "Add": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Remove": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Add", + "Remove" + ] + }, + "Needs": { + "properties": { + "Packages": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A list of packages needed by this pipeline" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Packages" + ] + }, + "OSRelease": { + "properties": { + "Name": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "VersionID": { + "type": "string" + }, + "PrettyName": { + "type": "string" + }, + "HomeURL": { + "type": "string" + }, + "BugReportURL": { + "type": "string" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Name", + "ID", + "VersionID", + "PrettyName", + "HomeURL", + "BugReportURL" + ] + }, + "Package": { + "properties": { + "name": { + "type": "string", + "description": "The name of the package" + }, + "version": { + "type": "string", + "description": "The version of the package" + }, + "epoch": { + "type": "integer", + "description": "The monotone increasing epoch of the package" + }, + "description": { + "type": "string", + "description": "A human readable description of the package" + }, + "url": { + "type": "string", + "description": "The URL to the package's homepage" + }, + "commit": { + "type": "string", + "description": "Optional: The git commit of the package build configuration" + }, + "target-architecture": { + "items": { + "type": "string" + }, + "type": "array", + "description": "List of target architectures for which this package should be build for" + }, + "copyright": { + "items": { + "$ref": "#/$defs/Copyright" + }, + "type": "array", + "description": "The list of copyrights for this package" + }, + "dependencies": { + "$ref": "#/$defs/Dependencies", + "description": "List of packages to depends on" + }, + "options": { + "$ref": "#/$defs/PackageOption", + "description": "Optional: Options that alter the packages behavior" + }, + "scriptlets": { + "$ref": "#/$defs/Scriptlets", + "description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events" + }, + "checks": { + "$ref": "#/$defs/Checks", + "description": "Optional: enabling, disabling, and configuration of build checks" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "name", + "version", + "epoch" + ] + }, + "PackageOption": { + "properties": { + "no-provides": { + "type": "boolean", + "description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty" + }, + "no-depends": { + "type": "boolean", + "description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package" + }, + "no-commands": { + "type": "boolean", + "description": "Optional: Mark this package as not providing any executables" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "no-provides", + "no-depends", + "no-commands" + ] + }, + "PathMutation": { + "properties": { + "Path": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "UID": { + "type": "integer" + }, + "GID": { + "type": "integer" + }, + "Permissions": { + "type": "integer" + }, + "Source": { + "type": "string" + }, + "Recursive": { + "type": "boolean" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Path", + "Type", + "UID", + "GID", + "Permissions", + "Source", + "Recursive" + ] + }, + "Pipeline": { + "properties": { + "name": { + "type": "string", + "description": "Optional: A user defined name for the pipeline" + }, + "uses": { + "type": "string", + "description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make" + }, + "with": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Optional: Arguments passed to the reusable pipelines defined in `uses`" + }, + "runs": { + "type": "string", + "description": "Optional: The command to run using the builder's shell (/bin/sh)" + }, + "pipeline": { + "items": { + "$ref": "#/$defs/Pipeline" + }, + "type": "array", + "description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`." + }, + "inputs": { + "additionalProperties": { + "$ref": "#/$defs/Input" + }, + "type": "object", + "description": "Optional: A map of inputs to the pipeline" + }, + "needs": { + "$ref": "#/$defs/Needs", + "description": "Optional: Configuration to determine any explicit dependencies this pipeline may have" + }, + "label": { + "type": "string", + "description": "Optional: Labels to apply to the pipeline" + }, + "if": { + "type": "string", + "description": "Optional: A condition to evaluate before running the pipeline" + }, + "assertions": { + "$ref": "#/$defs/PipelineAssertions", + "description": "Optional: Assertions to evaluate whether the pipeline was successful" + }, + "working-directory": { + "type": "string", + "description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)" + }, + "sbom": { + "$ref": "#/$defs/SBOM", + "description": "Optional: Configuration for the generated SBOM" + }, + "environment": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Optional: environment variables to override the apko environment" + } + }, + "additionalProperties": false, + "type": "object" + }, + "PipelineAssertions": { + "properties": { + "required-steps": { + "type": "integer", + "description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline." + } + }, + "additionalProperties": false, + "type": "object" + }, + "RangeData": { + "properties": { + "name": { + "type": "string" + }, + "items": { + "$ref": "#/$defs/DataItems" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "name", + "items" + ] + }, + "ReleaseMonitor": { + "properties": { + "identifier": { + "type": "integer", + "description": "Required: ID number for release monitor" + }, + "strip-prefix": { + "type": "string", + "description": "If the version in release monitor contains a prefix which should be ignored" + }, + "strip-suffix": { + "type": "string", + "description": "If the version in release monitor contains a suffix which should be ignored" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "identifier" + ], + "description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/" + }, + "SBOM": { + "properties": { + "language": { + "type": "string", + "description": "Optional: The language of the generated SBOM" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "language" + ] + }, + "Scriptlets": { + "properties": { + "trigger": { + "properties": { + "script": { + "type": "string" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "description": "Optional: A script to run on a custom trigger" + }, + "pre-install": { + "type": "string", + "description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter." + }, + "post-install": { + "type": "string", + "description": "Optional: The script to run post install. The script should contain the\nshebang interpreter." + }, + "pre-deinstall": { + "type": "string", + "description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter." + }, + "post-deinstall": { + "type": "string", + "description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter." + }, + "pre-upgrade": { + "type": "string", + "description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter." + }, + "post-upgrade": { + "type": "string", + "description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter." + } + }, + "additionalProperties": false, + "type": "object" + }, + "Subpackage": { + "properties": { + "if": { + "type": "string", + "description": "Optional: A conditional statement to evaluate for the subpackage" + }, + "range": { + "type": "string", + "description": "Optional: The iterable used to generate multiple subpackages" + }, + "name": { + "type": "string", + "description": "Required: Name of the subpackage" + }, + "pipeline": { + "items": { + "$ref": "#/$defs/Pipeline" + }, + "type": "array", + "description": "Optional: The list of pipelines that produce subpackage." + }, + "dependencies": { + "$ref": "#/$defs/Dependencies", + "description": "Optional: List of packages to depend on" + }, + "options": { + "$ref": "#/$defs/PackageOption", + "description": "Optional: Options that alter the packages behavior" + }, + "scriptlets": { + "$ref": "#/$defs/Scriptlets" + }, + "description": { + "type": "string", + "description": "Optional: The human readable description of the subpackage" + }, + "url": { + "type": "string", + "description": "Optional: The URL to the package's homepage" + }, + "commit": { + "type": "string", + "description": "Optional: The git commit of the subpackage build configuration" + }, + "checks": { + "$ref": "#/$defs/Checks", + "description": "Optional: enabling, disabling, and configuration of build checks" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "name" + ] + }, + "Update": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle if updates should occur" + }, + "manual": { + "type": "boolean", + "description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers" + }, + "shared": { + "type": "boolean", + "description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java" + }, + "version-separator": { + "type": "string", + "description": "Override the version separator if it is nonstandard" + }, + "ignore-regex-patterns": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A slice of regex patterns to match an upstream version and ignore" + }, + "release-monitor": { + "$ref": "#/$defs/ReleaseMonitor", + "description": "The configuration block for updates tracked via release-monitoring.org" + }, + "github": { + "$ref": "#/$defs/GitHubMonitor", + "description": "The configuration block for updates tracked via the Github API" + }, + "version-transform": { + "items": { + "$ref": "#/$defs/VersionTransform" + }, + "type": "array", + "description": "The configuration block for transforming the `package.version` into an APK version" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "enabled", + "manual" + ], + "description": "Update provides information used to describe how to keep the package up to date" + }, + "User": { + "properties": { + "UserName": { + "type": "string" + }, + "UID": { + "type": "integer" + }, + "GID": { + "type": "integer" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "UserName", + "UID", + "GID" + ] + }, + "VarTransforms": { + "properties": { + "from": { + "type": "string", + "description": "Required: The original template variable.\n\nExample: ${{package.version}}" + }, + "match": { + "type": "string", + "description": "Required: The regular expression to match against the `from` variable" + }, + "replace": { + "type": "string", + "description": "Required: The repl to replace on all `match` matches" + }, + "to": { + "type": "string", + "description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "from", + "match", + "replace", + "to" + ] + }, + "VersionTransform": { + "properties": { + "match": { + "type": "string", + "description": "Required: The regular expression to match against the `package.version` variable" + }, + "replace": { + "type": "string", + "description": "Required: The repl to replace on all `match` matches" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "match", + "replace" + ], + "description": "VersionTransform allows mapping the package version to an APK version" + } + } +}