schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
zinoma-schema.json
extensions
Filter files resource by file extensions. It should be an array of strings. If `extensions` are specified, only files matching at least one of the extensions will be included in the resource. __Example__ ```yaml targets: protoc: input: - paths: [protos] extensions: [proto] output: - paths: [protos] extensions: [go] build: | cd protos docker run -v `pwd`:/defs namely/protoc-all -d . -o . -l go
{"type": ["array", "null"], "items": {"type": "string"}}
zinoma-schema.json
paths
Paths to files or directories. It should be an array of strings. Each element of the array should be a path to a file or directory. If the `--clean` flag is provided to `zinoma`, the files or directories specified in `paths` will be deleted before running the build flow. __Example__ ```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ``` In this example, as the target specifies an `input`, `zinoma npm_install` is incremental. The script `npm install` will be skipped until `package.json`, `package-lock.json` or `node_modules` are modified. Additionally: - the command `zinoma --clean` will delete `node_modules`; - the command `zinoma --clean npm_install` will delete `node_modules`, then run `npm install`.
{"type": "array", "items": {"type": "string"}}
zinoma-schema.json
cmd_stdout
Shell script whose output identifies the state of a resource. It should be a string. __Example__ ```yaml targets: build_docker_image: input: - paths: [Dockerfile, src] - cmd_stdout: 'docker image ls base:latest --format "{{.ID}}"' output: - cmd_stdout: 'docker image ls webapp:latest --format "{{.ID}}"' build: docker build -t webapp . ```
{"type": "string"}
zinoma-schema.json
OutputResources
List of artifacts produced by this target. It should be an array of [`resources`]. [`resources`]: enum.OutputResource.html The incremental build takes in account the target `output`. Just like with [`input`], if any of the target output resources were altered since its previous successful execution, the target state will be invalidated and its build will be run again. [`input`]: struct.InputResources.html __Example__ ```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ``` In this example, running `zinoma npm_install` will return immediately in case `package.json`, `package-lock.json` and `node_modules` were not modified since the last completion of the target. Running `zinoma --clean npm_install` will start by deleting `node_modules`, then will run `npm install`.
{"type": "array", "items": {}}
zinoma-schema.json
Target
A target is a command or a set of commands to run as part of your build flow. Targets run in parallel by default. To force targets to run sequentially, you can define [`dependencies`] on other targets. [`dependencies`]: struct.Dependencies.html
{"anyOf": [{"type": "object", "required": ["build"], "properties": {"build": {"type": "string"}, "dependencies": {"default": [], "allOf": [{}]}, "input": {"default": [], "allOf": [{}]}, "output": {"default": [], "allOf": [{}]}}, "additionalProperties": false}, {"type": "object", "required": ["service"], "properties": {"dependencies": {"default": [], "allOf": [{}]}, "input": {"default": [], "allOf": [{}]}, "service": {"type": "string"}}, "additionalProperties": false}, {"type": "object", "required": ["dependencies"], "properties": {"dependencies": {"allOf": [{}]}}, "additionalProperties": false}]}
zinoma-schema.json
Target
A build target represents a shell script to run as part of your build flow. This build script is expected to eventually complete, as opposed to the run script of a [`service`] target. [`service`]: #variant.Service.field.service
{"type": "object", "required": ["build"], "properties": {"build": {"type": "string"}, "dependencies": {"default": [], "allOf": [{}]}, "input": {"default": [], "allOf": [{}]}, "output": {"default": [], "allOf": [{}]}}, "additionalProperties": false}
zinoma-schema.json
build
The shell script to run in order to build this target. It should be a string. This string can be multi-line, in case of scripts with multiple commands. __Example__ ```yaml targets: create_file_deep: build: | mkdir -p deep/dir touch deep/dir/file output: - paths: [deep/dir/file] ``` In this example, running `zinoma create_file_deep` will execute the commands `mkdir -p deep/dir` and `touch deep/dir/my_file` sequentially.
{"type": "string"}
zinoma-schema.json
dependencies
Dependencies of the target.
{"default": [], "allOf": [{}]}
zinoma-schema.json
input
Input resources of the target.
{"default": [], "allOf": [{}]}
zinoma-schema.json
output
Output resources of the target.
{"default": [], "allOf": [{}]}
zinoma-schema.json
Target
Service targets are useful to run scripts that do not complete. They enable the execution of long-lasting commands, such as servers.
{"type": "object", "required": ["service"], "properties": {"dependencies": {"default": [], "allOf": [{}]}, "input": {"default": [], "allOf": [{}]}, "service": {"type": "string"}}, "additionalProperties": false}
zinoma-schema.json
dependencies
Dependencies of the target.
{"default": [], "allOf": [{}]}
zinoma-schema.json
input
Input resources of the target.
{"default": [], "allOf": [{}]}
zinoma-schema.json
service
Shell script starting a long-lasting service. It should be a string. If `zinoma` has no service target to run, it will automatically exit after all build targets ran to completion. On the contrary, if at least one service target is specified in the command line, `zinoma` will keep running even after all build targets completed, so that the services can remain alive. In watch mode (when the `--watch` flag is passed to `zinoma`), services are restarted when the relevant paths are modified. __Example__ ```yaml targets: npm_server: input: - paths: [package.json, index.js] service: npm start ``` In this example, `zinoma npm_server --watch` will run `npm start`, and will restart this process every time `package.json` or `index.js` are updated.
{"type": "string"}
zinoma-schema.json
Target
Aggregates other targets. __Example__ ```yaml targets: fmt: build: cargo fmt -- --check lint: build: cargo clippy test: build: cargo test check: dependencies: [fmt, lint, test] ``` In this example, the target named `check` aggregates the 3 other targets. `zinoma check` is equivalent to running `zinoma fmt lint test`.
{"type": "object", "required": ["dependencies"], "properties": {"dependencies": {"allOf": [{}]}}, "additionalProperties": false}
zinoma-schema.json
dependencies
Dependencies of the target.
{"allOf": [{}]}
sourcehut-build-0.65.0.json
A recipe for Sourcehut CI service. For details, see https://man.sr.ht/builds.sr.ht/manifest.md.
{"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"image": {"type": "string", "examples": ["archlinux", "alpine/latest"]}, "arch": {"type": "string", "examples": ["aarch64", "x86_64"]}, "packages": {"type": "array", "items": {"type": "string"}}, "repositories": {"type": "object", "additionalProperties": {"type": "string"}}, "artifacts": {"type": "array", "items": {"type": "string"}, "examples": ["example/my-artifact.tar.gz"]}, "shell": {"type": "boolean"}, "sources": {"type": "array", "items": {"type": "string", "examples": ["https://git.sr.ht/~sircmpwn/scdoc", "https://git.sr.ht/~sircmpwn/scdoc#devel", "[email protected]:~sircmpwn/scdoc", "hg+https://hg.sr.ht/~sircmpwn/scdoc", "hg+ssh://hg.sr.ht/~sircmpwn/scdoc"]}}, "tasks": {"type": "array", "minItems": 1, "items": {"type": "object", "additionalProperties": {"type": "string"}, "propertyNames": {"pattern": "^[a-z0-9_-]{1,128}$"}, "examples": [{"package": "cd $site\ntar -cvz . > ../site.tar.gz"}]}}, "triggers": {"type": "array", "items": {"type": "object", "additionalProperties": true, "properties": {"action": {"type": "string", "enum": ["email", "webhook"]}, "condition": {"type": "string", "enum": ["always", "failure", "success"]}}, "required": ["action", "condition"]}}, "environment": {"type": "object", "additionalProperties": {"type": "string"}, "examples": [{"site": "your-username.srht.site"}]}, "secrets": {"type": "array", "items": {"type": "string", "examples": ["46f739e5-4538-45dd-a79f-bf173b7a2ed9"]}}, "oauth": {"type": "string", "examples": ["pages.sr.ht/PAGES:RW"]}}, "required": ["image", "tasks"], "type": "object"}
sourcehut-build-0.65.0.json
image
Which OS image to build in. A list of available build images can be found at https://man.sr.ht/builds.sr.ht/compatibility.md
{"type": "string", "examples": ["archlinux", "alpine/latest"]}
sourcehut-build-0.65.0.json
arch
Which architecture to build for. See https://man.sr.ht/builds.sr.ht/compatibility.md for a list of available architectures.
{"type": "string", "examples": ["aarch64", "x86_64"]}
sourcehut-build-0.65.0.json
packages
A list of packages to install on the image. For image-specific details, consult https://man.sr.ht/builds.sr.ht/compatibility.md
{"type": "array", "items": {"type": "string"}}
sourcehut-build-0.65.0.json
repositories
A list of extra repositories to enable with the image's package manager. The specific format varies by base image, consult https://man.sr.ht/builds.sr.ht/compatibility.md for details.
{"type": "object", "additionalProperties": {"type": "string"}}
sourcehut-build-0.65.0.json
artifacts
A list of files to extract from the completed build environment and make available for downloading from the jobs page. Artifacts are only uploaded for successful jobs and are pruned after 90 days. Note that the file names are interpreted literally: do not use ~ or any shell code. If a relative path is used (e.g. example/my-artifact.tar.gz), it will be interpreted relative to the build user's home directory.
{"type": "array", "items": {"type": "string"}, "examples": ["example/my-artifact.tar.gz"]}
sourcehut-build-0.65.0.json
shell
Whether to keep the build VM alive after all of the tasks have finished, even if it doesn't fail, so you can SSH in. You can also SSH in before the tasks have finished and tail the output of the build in your terminal. Learn more at https://man.sr.ht/builds.sr.ht/build-ssh.md
{"type": "boolean"}
sourcehut-build-0.65.0.json
sources
A list of repositories to clone into the home directory of the build user in the build environment. Optionally, prefix the protocol with the source control management scheme, to specify a protocol other than git. To specify a non-default git revision, append #commit-object to the repository.
{"type": "array", "items": {"type": "string", "examples": ["https://git.sr.ht/~sircmpwn/scdoc", "https://git.sr.ht/~sircmpwn/scdoc#devel", "[email protected]:~sircmpwn/scdoc", "hg+https://hg.sr.ht/~sircmpwn/scdoc", "hg+ssh://hg.sr.ht/~sircmpwn/scdoc"]}}
sourcehut-build-0.65.0.json
tasks
A list of scripts to execute in the build environment. Task names must use only lowercase alphanumeric characters, underscores or dashes and must be <=128 characters in length. Tasks are executed in the order specified. Each task is run in a separate login session, so if you modify the groups of the build user they will be effective starting from the subsequent task.
{"type": "array", "minItems": 1, "items": {"type": "object", "additionalProperties": {"type": "string"}, "propertyNames": {"pattern": "^[a-z0-9_-]{1,128}$"}, "examples": [{"package": "cd $site\ntar -cvz . > ../site.tar.gz"}]}}
sourcehut-build-0.65.0.json
triggers
A list of triggers to execute post-build, which can be used to send emails or do other post-build tasks. Learn more at https://man.sr.ht/builds.sr.ht/triggers.md
{"type": "array", "items": {"type": "object", "additionalProperties": true, "properties": {"action": {"type": "string", "enum": ["email", "webhook"]}, "condition": {"type": "string", "enum": ["always", "failure", "success"]}}, "required": ["action", "condition"]}}
sourcehut-build-0.65.0.json
action
Trigger type
{"type": "string", "enum": ["email", "webhook"]}
sourcehut-build-0.65.0.json
condition
When to execute this trigger
{"type": "string", "enum": ["always", "failure", "success"]}
sourcehut-build-0.65.0.json
environment
A list of key/value pairs for options to set in the build environment via ~/.buildenv
{"type": "object", "additionalProperties": {"type": "string"}, "examples": [{"site": "your-username.srht.site"}]}
sourcehut-build-0.65.0.json
secrets
List of secret UUIDs to be added to the guest during the build. Learn more at https://man.sr.ht/builds.sr.ht/#secrets
{"type": "array", "items": {"type": "string", "examples": ["46f739e5-4538-45dd-a79f-bf173b7a2ed9"]}}
sourcehut-build-0.65.0.json
oauth
If present, and secrets are enabled for this build, an OAuth 2.0 bearer token is generated for this build with the given string as the list of grants. The acurl command may be used in the task scripts to perform authenticated GraphAL API requests (https://man.sr.ht/graphql.md).
{"type": "string", "examples": ["pages.sr.ht/PAGES:RW"]}
renovate-schema.json
addLabels
Labels to add to Pull Request.
{"type": "array", "items": {"type": "string"}}
renovate-schema.json
additionalBranchPrefix
Additional string value to be appended to `branchPrefix`.
{"type": "string", "default": ""}
renovate-schema.json
additionalReviewers
Additional reviewers for Pull Requests (in contrast to `reviewers`, this option adds to the existing reviewer list, rather than replacing it).
{"type": "array", "items": {"type": "string"}}
renovate-schema.json
allowCustomCrateRegistries
Set this to `true` to allow custom crate registries.
{"type": "boolean", "default": false}
renovate-schema.json
allowPlugins
Set this to `true` if repositories are allowed to run install plugins.
{"type": "boolean", "default": false}
renovate-schema.json
allowPostUpgradeCommandTemplating
Set this to `false` to disable template compilation for post-upgrade commands.
{"type": "boolean", "default": true}
renovate-schema.json
allowScripts
Set this to `true` if repositories are allowed to run install scripts.
{"type": "boolean", "default": false}
renovate-schema.json
allowedPostUpgradeCommands
A list of regular expressions that decide which post-upgrade tasks are allowed.
{"type": "array", "items": {"type": "string"}, "default": []}
renovate-schema.json
ansible
Configuration object for the ansible manager
{"type": "object", "default": {"fileMatch": ["(^|/)tasks/[^/]+\\.ya?ml$"]}}
renovate-schema.json
ansible-galaxy
Configuration object for the ansible-galaxy manager
{"type": "object", "default": {"fileMatch": ["(^|/)requirements\\.ya?ml$", "(^|/)galaxy\\.ya?ml$"]}}
renovate-schema.json
argocd
Configuration object for the argocd manager
{"type": "object", "default": {"fileMatch": []}}
renovate-schema.json
asdf
Configuration object for the asdf manager
{"type": "object", "default": {"fileMatch": ["(^|/)\\.tool-versions$"]}}
renovate-schema.json
assignAutomerge
Assign reviewers and assignees even if the PR is to be automerged.
{"type": "boolean", "default": false}
renovate-schema.json
assignees
Assignees for Pull Request (either username or email address depending on the platform).
{"type": "array", "items": {"type": "string"}}
renovate-schema.json
assigneesFromCodeOwners
Determine assignees based on configured code owners and changes in PR.
{"type": "boolean", "default": false}
renovate-schema.json
assigneesSampleSize
Take a random sample of given size from `assignees`.
{"type": "integer", "default": null}
renovate-schema.json
autoApprove
Set to `true` to automatically approve PRs.
{"type": "boolean", "default": false}
renovate-schema.json
autoReplaceGlobalMatch
Control whether replacement regular expressions are global matches or only the first match.
{"type": "boolean", "default": true}
renovate-schema.json
autodiscover
Autodiscover all repositories.
{"type": "boolean", "default": false}
renovate-schema.json
autodiscoverFilter
Filter the list of autodiscovered repositories.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}], "default": null}
renovate-schema.json
autodiscoverTopics
Filter the list of autodiscovered repositories by topics.
{"type": "array", "items": {"type": "string"}, "default": null}
renovate-schema.json
automerge
Whether to automerge branches/PRs automatically, without human intervention.
{"type": "boolean", "default": false}
renovate-schema.json
automergeComment
PR comment to add to trigger automerge. Only used if `automergeType=pr-comment`.
{"type": "string", "default": "automergeComment"}
renovate-schema.json
automergeSchedule
Limit automerge to these times of day or week.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}], "default": ["at any time"]}
renovate-schema.json
automergeStrategy
The merge strategy to use when automerging PRs. Used only if `automergeType=pr`.
{"type": "string", "enum": ["auto", "fast-forward", "merge-commit", "rebase", "squash"], "default": "auto"}
renovate-schema.json
automergeType
How to automerge, if enabled.
{"type": "string", "enum": ["branch", "pr", "pr-comment"], "default": "pr"}
renovate-schema.json
azure-pipelines
Configuration object for the azure-pipelines manager
{"type": "object", "default": {"fileMatch": ["azure.*pipelines?.*\\.ya?ml$"], "enabled": false}}
renovate-schema.json
azureWorkItemId
The id of an existing work item on Azure Boards to link to each PR.
{"type": "integer", "default": 0}
renovate-schema.json
baseBranches
List of one or more custom base branches defined as exact strings and/or via regex expressions.
{"type": "array", "items": {"type": "string"}}
renovate-schema.json
baseDir
The base directory for Renovate to store local files, including repository files and cache. If left empty, Renovate will create its own temporary directory to use.
{"type": "string"}
renovate-schema.json
batect
Configuration object for the batect manager
{"type": "object", "default": {"fileMatch": ["(^|/)batect(-bundle)?\\.ya?ml$"]}}
renovate-schema.json
batect-wrapper
Configuration object for the batect-wrapper manager
{"type": "object", "default": {"fileMatch": ["(^|/)batect$"], "versioning": "semver"}}
renovate-schema.json
bazel
Configuration object for the bazel manager
{"type": "object", "default": {"fileMatch": ["(^|/)WORKSPACE(|\\.bazel)$", "\\.bzl$"]}}
renovate-schema.json
bazel-module
Configuration object for the bazel-module manager
{"type": "object", "default": {"fileMatch": ["(^|/)MODULE\\.bazel$"]}}
renovate-schema.json
bazelisk
Configuration object for the bazelisk manager
{"type": "object", "default": {"fileMatch": ["(^|/)\\.bazelversion$"], "pinDigests": false, "versioning": "semver"}}
renovate-schema.json
bbUseDefaultReviewers
Use the default reviewers (Bitbucket only).
{"type": "boolean", "default": true}
renovate-schema.json
bbUseDevelopmentBranch
Use the repository's [development branch](https://support.atlassian.com/bitbucket-cloud/docs/branch-a-repository/#The-branching-model) as the repository's default branch.
{"type": "boolean", "default": false}
renovate-schema.json
bicep
Configuration object for the bicep manager
{"type": "object", "default": {"fileMatch": ["\\.bicep$"]}}
renovate-schema.json
binarySource
Controls how third-party tools like npm or Gradle are called: directly, via Docker sidecar containers, or via dynamic install.
{"type": "string", "enum": ["global", "docker", "install", "hermit"], "default": "install"}
renovate-schema.json
bitbucket-pipelines
Configuration object for the bitbucket-pipelines manager
{"type": "object", "default": {"fileMatch": ["(^|/)\\.?bitbucket-pipelines\\.ya?ml$"]}}
renovate-schema.json
branchConcurrentLimit
Limit to a maximum of x concurrent branches. 0 means no limit, `null` (default) inherits value from `prConcurrentLimit`.
{"type": "integer", "default": null}
renovate-schema.json
branchName
Branch name template.
{"type": "string", "default": "{{{branchPrefix}}}{{{additionalBranchPrefix}}}{{{branchTopic}}}"}
renovate-schema.json
branchNameStrict
Whether to be strict about the use of special characters within the branch name.
{"type": "boolean", "default": false}
renovate-schema.json
branchPrefix
Prefix to use for all branch names.
{"type": "string", "default": "renovate/"}
renovate-schema.json
branchPrefixOld
Old branchPrefix value to check for existing PRs.
{"type": "string", "default": "renovate/"}
renovate-schema.json
branchTopic
Branch topic.
{"type": "string", "default": "{{{depNameSanitized}}}-{{{newMajor}}}{{#if separateMinorPatch}}{{#if isPatch}}.{{{newMinor}}}{{/if}}{{/if}}.x{{#if isLockfileUpdate}}-lockfile{{/if}}"}
renovate-schema.json
buildkite
Configuration object for the buildkite manager
{"type": "object", "default": {"fileMatch": ["buildkite\\.ya?ml", "\\.buildkite/.+\\.ya?ml$"], "commitMessageTopic": "buildkite plugin {{depName}}", "commitMessageExtra": "to {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{{newValue}}}{{/if}}"}}
renovate-schema.json
bumpVersion
Bump the version in the package file being updated.
{"type": "string", "enum": ["major", "minor", "patch", "prerelease"]}
renovate-schema.json
bundler
Configuration object for the bundler manager
{"type": "object", "default": {"fileMatch": ["(^|/)Gemfile$"], "versioning": "ruby"}}
renovate-schema.json
cacheDir
The directory where Renovate stores its cache. If left empty, Renovate creates a subdirectory within the `baseDir`.
{"type": "string"}
renovate-schema.json
cacheHardTtlMinutes
Maximum duration in minutes to keep datasource cache entries.
{"type": "integer", "default": 1440}
renovate-schema.json
cake
Configuration object for the cake manager
{"type": "object", "default": {"fileMatch": ["\\.cake$"]}}
renovate-schema.json
cargo
Configuration object for the cargo manager
{"type": "object", "default": {"commitMessageTopic": "Rust crate {{depName}}", "fileMatch": ["(^|/)Cargo\\.toml$"], "versioning": "cargo"}}
renovate-schema.json
cdnurl
Configuration object for the cdnurl manager
{"type": "object", "default": {"fileMatch": [], "versioning": "semver"}}
renovate-schema.json
checkedBranches
A list of branch names to mark for creation or rebasing as if it was selected in the Dependency Dashboard issue.
{"type": "array", "items": {"type": "string"}, "default": []}
renovate-schema.json
circleci
Configuration object for the circleci manager
{"type": "object", "default": {"fileMatch": ["(^|/)\\.circleci/config\\.ya?ml$"]}}
renovate-schema.json
cloneSubmodules
Set to `true` to initialize submodules during repository clone.
{"type": "boolean", "default": false}
renovate-schema.json
cloudbuild
Configuration object for the cloudbuild manager
{"type": "object", "default": {"fileMatch": ["(^|/)cloudbuild\\.ya?ml"]}}
renovate-schema.json
cocoapods
Configuration object for the cocoapods manager
{"type": "object", "default": {"fileMatch": ["(^|/)Podfile$"], "versioning": "ruby"}}
renovate-schema.json
commitBody
Commit message body template. Will be appended to commit message, separated by two line returns.
{"type": "string"}
renovate-schema.json
commitBodyTable
If enabled, append a table in the commit message body describing all updates in the commit.
{"type": "boolean", "default": false}
renovate-schema.json
commitMessage
Message to use for commit messages and pull request titles.
{"type": "string", "default": "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}"}
renovate-schema.json
commitMessageAction
Action verb to use in commit messages and PR titles.
{"type": "string", "default": "Update"}
renovate-schema.json
commitMessageExtra
Extra description used after the commit message topic - typically the version.
{"type": "string", "default": "to {{#if isPinDigest}}{{{newDigestShort}}}{{else}}{{#if isMajor}}{{prettyNewMajor}}{{else}}{{#if isSingleVersion}}{{prettyNewVersion}}{{else}}{{#if newValue}}{{{newValue}}}{{else}}{{{newDigestShort}}}{{/if}}{{/if}}{{/if}}{{/if}}"}
renovate-schema.json
commitMessageLowerCase
Lowercase PR- and commit titles.
{"type": "string", "enum": ["auto", "never"], "default": "auto"}
renovate-schema.json
commitMessagePrefix
Prefix to add to start of commit messages and PR titles. Uses a semantic prefix if `semanticCommits` is enabled.
{"type": "string"}
renovate-schema.json
commitMessageSuffix
Suffix to add to end of commit messages and PR titles.
{"type": "string"}
renovate-schema.json
commitMessageTopic
The upgrade topic/noun used in commit messages and PR titles.
{"type": "string", "default": "dependency {{depName}}"}
renovate-schema.json
composer
Configuration object for the composer manager
{"type": "object", "default": {"fileMatch": ["(^|/)([\\w-]*)composer\\.json$"], "versioning": "composer"}}