Skip to content

Update JSON schema for plugin v2 #1898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 14, 2024
Merged

Update JSON schema for plugin v2 #1898

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions .schema/devbox-plugin.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,74 @@
"description": "A short description of the plugin and how it works. This will automatically display when the user first installs the plugin, or runs `devbox info`",
"type": "string"
},
"packages": {
"description": "Collection of packages to install",
"oneOf": [
{
"type": "array",
"items": {
"description": "Name and version of each package in name@version format.",
"type": "string"
}
},
{
"type": "object",
"description": "Name of each package in {\"name\": {\"version\": \"1.2.3\"}} format.",
"patternProperties": {
".*": {
"oneOf": [
{
"type": "object",
"description": "Version number of the specified package in {\"version\": \"1.2.3\"} format.",
"properties": {
"version": {
"type": "string",
"description": "Version of the package"
},
"platforms": {
"type": "array",
"description": "Names of platforms to install the package on. This package will be skipped for any platforms not on this list",
"items": {
"enum": [
"i686-linux",
"aarch64-linux",
"aarch64-darwin",
"x86_64-darwin",
"x86_64-linux",
"armv7l-linux"
]
}
},
"excluded_platforms": {
"type": "array",
"description": "Names of platforms to exclude the package on",
"items": {
"enum": [
"i686-linux",
"aarch64-linux",
"aarch64-darwin",
"x86_64-darwin",
"x86_64-linux",
"armv7l-linux"
]
}
},
"glibc_patch": {
"type": "boolean",
"description": "Whether to patch glibc to the latest available version for this package"
}
}
},
{
"type": "string",
"description": "Version of the package to install."
}
]
}
}
}
]
},
"env": {
"type": "object",
"description": "List of additional environment variables to be set in the Devbox environment. These can be overridden by environment variables set in the user's devbox.json",
Expand Down Expand Up @@ -48,8 +116,30 @@
"init_hook": {
"type": ["array", "string"],
"description": "Shell command to run right before initializing the user's shell, running a script, or starting a service"
},
"scripts": {
"description": "List of command/script definitions to run with `devbox run <script_name>`.",
"type": "object",
"patternProperties": {
".*": {
"description": "Alias name for the script.",
"type": ["array", "string"],
"items": {
"type": "string",
"description": "The script's shell commands."
}
}
}
}
}
},
"include": {
"description": "List of additional plugins to activate within your devbox shell",
"type": "array",
"items": {
"description": "Name of the plugin to activate.",
"type": "string"
}
}
},
"required": ["name", "version", "readme"]
Expand Down