SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
cc8d62f6d5
PTU5KAS/kas/schema-kas.json

290 lines
9.5 KiB
JSON
Raw Normal View History

yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
{
schema-kas.json: Fix dialect URL Use the proper one according to https://json-schema.org/understanding-json-schema/reference/schema.html. Will help jsonschema to find the right validator. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-05-26 17:31:36 +02:00
"$schema": "http://json-schema.org/draft-04/schema#",
add meta-schema identifiers in kas json schema This patch adds the required meta-schema identifiers to allow automatic validation against a fixed version of json-schema. Reported-by: Ross Burton <ross@burtonini.com> Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-04-03 14:26:50 +02:00
"$id": "https://github.com/siemens/kas/blob/master/kas/schema-kas.json",
"title": "kas configuration",
"description": "kas, a setup tool for bitbake based projects",
yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
"type": "object",
"required": [
"header"
],
"additionalProperties": false,
"properties": {
"header": {
"type": "object",
"required": [
"version"
],
"additionalProperties": false,
"properties": {
"version": {
"oneOf": [
{
"type": "string",
"enum": [
"0.10"
]
},
{
"type": "integer"
}
]
},
"includes": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"required": [
"repo",
"file"
],
"additionalProperties": false,
"properties": {
"repo": {
"type": "string"
},
"file": {
"type": "string"
}
}
}
]
}
}
}
},
"build_system": {
"type": "string",
"enum": [
"openembedded",
"oe",
"isar"
]
},
"defaults": {
"type": "object",
"additionalProperties": false,
"properties": {
"repos": {
"type": "object",
"additionalProperties": false,
"properties": {
repos: Introduce commit and branch and alternative to refspec key This allows to clearly express if a refspec is a commit ID or a branch/symbolic reference. Mixing repos with old refspec with repos that uses new commit/branch is supported, but not mixing the keys in the same repo. This commit lays the ground by extending the schema and ensuring that the code which at minimum needs to know about these new keys does so. Existing tests still pass, new ones will follow. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-05-30 16:55:07 +02:00
"branch": {
"type": "string"
},
yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
"refspec": {
"type": "string"
},
"patches": {
"type": "object",
"additionalProperties": false,
"properties": {
"repo": {
"type": "string"
}
}
}
}
}
}
},
add support to override refspec of repos This patch adds the top-level `overrides` entry, which is used to override (or pin) the refspec of repositories. The main difference to a direct override is that this logic only applies to repos that are already defined. By that, a superset of all repos can be added to this entry (similar to a global lockfile), but only the currently active ones are affected. A new top-level keyword is required because everything below the "repos" keyword is potentially defined by "default" values. For the locking mechanism, a clear separation between overrides (only override if existing) and definitions is required to be able to define a global lockfile with all possible repos, while just defining some repos. Proposed-by: Ross Burton <ross@burtonini.com> Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com> [Jan: also bump __file_version__] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-04-23 11:42:25 +02:00
"overrides": {
"type": "object",
"additionalProperties": false,
"properties": {
"repos": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
Switch overrides and dump plugin to new commit/branch schema Lock files are now using the commit key, rather than legacy refspec, and the plugin writes out flattened configs that are in line with the input configs (only write refspec if input repo was using refspec). This also requires slight adjustments of the related test case. Enhance the dump test at this chance to actually validate the written commit ID against the expected one. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-05-30 17:32:03 +02:00
"commit": {
add support to override refspec of repos This patch adds the top-level `overrides` entry, which is used to override (or pin) the refspec of repositories. The main difference to a direct override is that this logic only applies to repos that are already defined. By that, a superset of all repos can be added to this entry (similar to a global lockfile), but only the currently active ones are affected. A new top-level keyword is required because everything below the "repos" keyword is potentially defined by "default" values. For the locking mechanism, a clear separation between overrides (only override if existing) and definitions is required to be able to define a global lockfile with all possible repos, while just defining some repos. Proposed-by: Ross Burton <ross@burtonini.com> Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com> [Jan: also bump __file_version__] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-04-23 11:42:25 +02:00
"type": "string"
}
}
}
}
}
},
yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
"machine": {
"type": "string"
},
"distro": {
"type": "string"
},
"env": {
"type": "object",
"additionalProperties": {
add conditional environment variables Until now all environment variables in the kas config's env section require a default value. In some cases we want to rely on the weak assignment of bitbake instead of relying on the default value of the variable in the kas config. This means if we assign the 'None' value or nothing to the variable in the kas config then it is only added to BB_ENV_EXTRAWHITE or BB_ENV_PASSTHROUGH_ADDITIONS without setting it as environment variable. Signed-off-by: Benedikt Niedermayr <benedikt.niedermayr@siemens.com> [Jan: fixed overlong line] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2022-11-10 13:46:45 +01:00
"type": ["string", "null"]
yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
}
},
"target": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"task": {
"type": "string"
},
"repos": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"url": {
Allow "deleting" url/path of repo in override Make "null" an allowed type for the `url` and `path` properties of a repository. This allows "deleting" them in an override kas-file to e.g. point a repository at a local directory instead of a git remote: "Original" file: repos: meta-foo: url: https://example.org/foo.git refspec: badc0ffee Override: repos: meta-foo: url: path: /path/to/local/foo Without the explicit "nulling" of the URL, kas would start messing with the repo in /path/to/local/foo (changing remote URL, switching to a different rev, etc.). With this change, we can instead force kas to use the recipes in that directory untouched. Signed-off-by: Harald Seiler <hws@denx.de> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2022-04-06 12:16:38 +02:00
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
},
"type": {
"type": "string"
},
repos: Introduce commit and branch and alternative to refspec key This allows to clearly express if a refspec is a commit ID or a branch/symbolic reference. Mixing repos with old refspec with repos that uses new commit/branch is supported, but not mixing the keys in the same repo. This commit lays the ground by extending the schema and ensuring that the code which at minimum needs to know about these new keys does so. Existing tests still pass, new ones will follow. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-05-30 16:55:07 +02:00
"commit": {
"type": "string"
},
"branch": {
"type": "string"
},
yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
"refspec": {
"type": "string"
},
"path": {
Allow "deleting" url/path of repo in override Make "null" an allowed type for the `url` and `path` properties of a repository. This allows "deleting" them in an override kas-file to e.g. point a repository at a local directory instead of a git remote: "Original" file: repos: meta-foo: url: https://example.org/foo.git refspec: badc0ffee Override: repos: meta-foo: url: path: /path/to/local/foo Without the explicit "nulling" of the URL, kas would start messing with the repo in /path/to/local/foo (changing remote URL, switching to a different rev, etc.). With this change, we can instead force kas to use the recipes in that directory untouched. Signed-off-by: Harald Seiler <hws@denx.de> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2022-04-06 12:16:38 +02:00
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
},
"layers": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "string"
}
]
}
},
"patches": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"path"
],
"properties": {
"repo": {
"type": "string"
},
"path": {
"type": "string"
}
}
},
{
"type": "null"
}
]
}
}
}
},
{
"type": "null"
}
]
}
},
"bblayers_conf_header": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"local_conf_header": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"proxy_config": {
"type": "object",
"additionalProperties": false,
"properties": {
"http_proxy": {
"type": "string"
},
"https_proxy": {
"type": "string"
},
"ftp_proxy": {
"type": "string"
},
"no_proxy": {
"type": "string"
}
}
Add kconfiglib-based menu plugin This uses the kconfiglib python module to implement simple interactive configuration for complex layers with many kas options and even variable input. See the menu.py documentation header for details on the Kconfig format and its translation to kas. Rather than using the limited menuconfig implementation of kconfiglib, this comes with an own, python-newt based version. The permits smooth integration in the workflow, e.g. to offer an option that directly triggers a build after completing a configuration. And it comes with a nicer layout. Unfortunately, python-newt can't be fulfilled via pip. But it is available as proper package via common distros. So warn if the package is missing. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-07-10 11:25:13 +02:00
},
"menu_configuration": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "integer"
}
]
}
menu plugin: track root repo dir This patch adds a new top-level schema node `_source_dir` which is used to track the top repo dir on auto-generated kas files. This node is generated by the kas menu plugin and provides the absolute path to the top repo dir at time of invoking the plugin. When later calling any other kas operation that performs a checkout, this node is evaluated and the top repo dir is set accordingly. This tracking is required when the build command is executed from another dir than the top repo dir, as the repo-dir cannot be computed by kas in this case (the .config.yaml file is in the KAS_WORK_DIR, not in the repo dir). Proposed-by: Peter Hoyes <Peter.Hoyes@arm.com> Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com> [Jan: aligned format-changelog text, simplified load_config returning] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-05-26 06:39:42 +02:00
},
"_source_dir": {
"type": "string"
kas-container: track repo dir when using menu cmd When using the kas menu command, we need to track the repository location outside of the kas container as well. This is required to prepare the environment for a later kas-container build, as the repo path inside the container is different from the outside one. For that, the location of KAS_REPO_DIR is passed via an env-var into the container. There, this value is picked up by the menu plugin and written to the .config.yaml file as `_source_host_dir`. When running kas-container build, we check if the .config.yaml file contains this node and set the KAS_REPO_DIR accordingly. The schema is extended accordingly. Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com> [Jan: rework _source_dir_host extraction to make it usable for menu as well] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-05-26 06:39:43 +02:00
},
"_source_dir_host": {
"type": "string"
yml: Move json schema from python dict to standalone json file - Easier to reference as schema for IDEs - Can be added to schemastore.org Signed-off-by: ciarancourtney <ciaran.courtney@activeenergy.ie> [Jan: rebased, merged in schema installation] Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-10-04 18:41:37 +02:00
}
}
}
Reference in New Issue Copy Permalink