schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
config.json | rootdir | RootDir defines the root directory used to recursively search for npm packages.json | {"type": "string"} |
config.json | ignore | Ignore allows to specify rule to ignore autodiscovery a specific NPM based on a rule | {"items": {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"} |
config.json | items | MatchingRule allows to specifies rules to identify manifest | {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"} |
config.json | path | Path specifies a package.json path pattern, the pattern requires to match all of name, not just a substring. | {"type": "string"} |
config.json | only | Only allows to specify rule to only autodiscover manifest for a specific NPM based on a rule | {"items": {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"} |
config.json | items | MatchingRule allows to specifies rules to identify manifest | {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"} |
config.json | path | Path specifies a package.json path pattern, the pattern requires to match all of name, not just a substring. | {"type": "string"} |
config.json | versionfilter | versionfilter provides parameters to specify the version pattern used when generating manifest.
kind - semver
versionfilter of kind `semver` uses semantic versioning as version filtering
pattern accepts one of:
`patch` - patch only update patch version
`minor` - minor only update minor version
`maj... | {"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict": {"type": "boolean"}}, "additionalProperties": false, "type": "object"} |
config.json | kind | specifies the version kind such as semver, regex, or latest | {"type": "string"} |
config.json | pattern | specifies the version pattern according the version kind | {"type": "string"} |
config.json | strict | strict enforce strict versioning rule. Only used for semantic versioning at this time | {"type": "boolean"} |
config.json | rancher/fleet | Spec defines the parameters which can be provided to the fleet builder. | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"rootdir": {"type": "string"}, "ignore": {"items": {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"}, "only": {"items": {"properties": {"path": {"type": "string"}}, "additionalProperties": ... |
config.json | rootdir | RootDir defines the root directory used to recursively search for Fleet bundle | {"type": "string"} |
config.json | ignore | Ignore allows to specify rule to ignore autodiscovery a specific Fleet bundle based on a rule | {"items": {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"} |
config.json | items | MatchingRule allows to specifies rules to identify manifest | {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"} |
config.json | path | Path specifies a Fleet bundle path pattern, the pattern requires to match all of name, not just a substring. | {"type": "string"} |
config.json | only | Only allows to specify rule to only autodiscover manifest for a specific Fleet bundle based on a rule | {"items": {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"}, "type": "array"} |
config.json | items | MatchingRule allows to specifies rules to identify manifest | {"properties": {"path": {"type": "string"}}, "additionalProperties": false, "type": "object"} |
config.json | path | Path specifies a Fleet bundle path pattern, the pattern requires to match all of name, not just a substring. | {"type": "string"} |
config.json | versionfilter | versionfilter provides parameters to specify the version pattern used when generating manifest.
kind - semver
versionfilter of kind `semver` uses semantic versioning as version filtering
pattern accepts one of:
`patch` - patch only update patch version
`minor` - minor only update minor version
`maj... | {"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict": {"type": "boolean"}}, "additionalProperties": false, "type": "object"} |
config.json | kind | specifies the version kind such as semver, regex, or latest | {"type": "string"} |
config.json | pattern | specifies the version pattern according the version kind | {"type": "string"} |
config.json | strict | strict enforce strict versioning rule. Only used for semantic versioning at this time | {"type": "boolean"} |
config.json | scmid | scmid is a unique identifier used to retrieve the scm configuration from the configuration file. | {"type": "string"} |
config.json | actionid | actionid is a unique identifier used to retrieve the action configuration from the configuration file. | {"type": "string"} |
config.json | groupby | groupby specifies how to group pipeline. The Accepted is one of "all", "individual". Default is "all"
default:
all | {"type": "string"} |
config.json | pullrequestid | !Deprecated in favor of `actionid` | {"type": "string"} |
config.json | title | Title is used for the full pipeline | {"type": "string"} |
config.json | actions | Actions defines the list of action configurations which need to be managed | {"patternProperties": {".*": {"oneOf": [{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"kind": {"enum": ["github/pullrequest"]}, "spec": {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"automerge": {"type": "boolean"}, "labels": {"items": {"type": "string"}, "type": "array"}, ... |
config.json | spec | ActionSpec specifies the configuration of an action of type "GitHub Pull Request" | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"automerge": {"type": "boolean"}, "labels": {"items": {"type": "string"}, "type": "array"}, "draft": {"type": "boolean"}, "maintainercannotmodify": {"type": "boolean"}, "mergemethod": {"type": "string"}, "usetitleforautomerge": {"type": "boolean"}, "p... |
config.json | automerge | Specifies if automerge is enabled for the new pullrequest | {"type": "boolean"} |
config.json | title | Specifies the Pull Request title | {"type": "string"} |
config.json | description | Specifies user input description used during pull body creation | {"type": "string"} |
config.json | labels | Specifies repository labels used for the Pull Request. !! Labels must already exist on the repository | {"items": {"type": "string"}, "type": "array"} |
config.json | draft | Specifies if a Pull Request is set to draft, default false | {"type": "boolean"} |
config.json | maintainercannotmodify | Specifies if maintainer can modify pullRequest | {"type": "boolean"} |
config.json | mergemethod | Specifies which merge method is used to incorporate the Pull Request. Accept "merge", "squash", "rebase", or "" | {"type": "string"} |
config.json | usetitleforautomerge | Specifies to use the Pull Request title as commit message when using auto merge, only works for "squash" or "rebase" | {"type": "boolean"} |
config.json | parent | Specifies if a Pull Request should be sent to the parent of a fork. | {"type": "boolean"} |
config.json | spec | Spec defines settings used to interact with Gitea pullrequest It's a mapping of user input from a Updatecli manifest and it shouldn't modified | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "sourcebranch": {"type": "string"}, "targetbranch": {"type": "string"}, "owner": {"type": "string"}, "repository": {"type": "string"}, "body": {"type": "string"}},... |
config.json | url | "url" defines the Gitea url to interact with | {"type": "string"} |
config.json | username | "username" defines the username used to authenticate with Gitea API | {"type": "string"} |
config.json | token | "token" specifies the credential used to authenticate with Gitea API | {"type": "string"} |
config.json | sourcebranch | "sourcebranch" defines the branch name used as a source to create the Gitea pullrequest.
default:
"sourcebranch" inherits the value from the scm branch if a scm of kind "gitea" is specified by the action.
remark:
unless you know what you are doing, you shouldn't set this value and rely on the scmid to provi... | {"type": "string"} |
config.json | targetbranch | "targetbranch" defines the branch name used as a target to create the Gitea pullrequest.
default:
"targetbranch" inherits the value from the scm working branch if a scm of kind "gitea" is specified by the action.
remark:
unless you know what you are doing, you shouldn't set this value and rely on the scmid ... | {"type": "string"} |
config.json | owner | "owner" defines the Gitea repository owner.
remark:
unless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default. | {"type": "string"} |
config.json | repository | "repository" defines the Gitea repository for a specific owner
remark:
unless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default. | {"type": "string"} |
config.json | title | "title" defines the Gitea pullrequest title
default:
A Gitea pullrequest title is defined by one of the following location (first match)
1. title is defined by the spec such as:
actions:
default:
kind: gitea/pullrequest
scmid: default
spec:
title: This is my awesome ti... | {"type": "string"} |
config.json | body | "body" defines a custom body pullrequest.
default:
By default a pullrequest body is generated out of a pipeline execution.
remark:
Unless you know what you are doing, you shouldn't set this value and rely on the sane default.
"body" is useful to provide additional information when reviewing pullrequest, ... | {"type": "string"} |
config.json | spec | Spec defines settings used to interact with Bitbucket pullrequest It's a mapping of user input from a Updatecli manifest and it shouldn't modified | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "password": {"type": "string"}, "owner": {"type": "string"}, "repository": {"type": "string"}, "sourcebranch": {"type": "string"}, "targetbranch": {"type": "string... |
config.json | url | [S][C][T] URL specifies the default github url in case of Bitbucket enterprise | {"type": "string"} |
config.json | username | [S][C][T] Username specifies the username used to authenticate with Bitbucket API | {"type": "string"} |
config.json | token | [S][C][T] Token specifies the credential used to authenticate with | {"type": "string"} |
config.json | password | [S][C][T] Token specifies the credential used to authenticate with | {"type": "string"} |
config.json | owner | Owner specifies repository owner | {"type": "string"} |
config.json | repository | Repository specifies the name of a repository for a specific owner | {"type": "string"} |
config.json | sourcebranch | SourceBranch specifies the pullrequest source branch | {"type": "string"} |
config.json | targetbranch | TargetBranch specifies the pullrequest target branch | {"type": "string"} |
config.json | title | Title defines the Bitbucket pullrequest title. | {"type": "string"} |
config.json | body | Body defines the Bitbucket pullrequest body | {"type": "string"} |
config.json | spec | Spec defines settings used to interact with GitLab pullrequest It's a mapping of user input from a Updatecli manifest and it shouldn't modified | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "sourcebranch": {"type": "string"}, "targetbranch": {"type": "string"}, "owner": {"type": "string"}, "repository": {"type": "string"}, "body": {"type": "string"}},... |
config.json | url | "url" defines the GitLab url to interact with
default:
url defaults to "gitlab.com" | {"type": "string"} |
config.json | username | "username" defines the username used to authenticate with GitLab | {"type": "string"} |
config.json | token | "token" defines the credential used to authenticate with GitLab | {"type": "string"} |
config.json | sourcebranch | "sourcebranch" defines the branch name used as a source to create the GitLab mergerequest.
default:
"sourcebranch" inherits the value from the scm branch if a scm of kind "gitlab" is specified by the action.
remark:
unless you know what you are doing, you shouldn't set this value and rely on the scmid to pr... | {"type": "string"} |
config.json | targetbranch | "targetbranch" defines the branch name used as a target to create the GitLab mergerequest.
default:
"targetbranch" inherits the value from the scm working branch if a scm of kind "gitlab" is specified by the action.
remark:
unless you know what you are doing, you shouldn't set this value and rely on the scm... | {"type": "string"} |
config.json | owner | "owner" defines the GitLab repository owner.
remark:
unless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default. | {"type": "string"} |
config.json | repository | "repository" defines the GitLab repository for a specific owner
remark:
unless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default. | {"type": "string"} |
config.json | title | "title" defines the GitLab mergerequest title
default:
A GitLab mergerequest title is defined by one of the following location (first match)
1. title is defined by the spec such as:
actions:
default:
kind: gitlab/mergerequest
scmid: default
spec:
title: This is my awes... | {"type": "string"} |
config.json | body | "body" defines a custom mergerequest body
default:
By default a mergerequest body is generated out of a pipeline execution.
remark:
Unless you know what you are doing, you shouldn't set this value and rely on the sane default.
"body" is useful to provide additional information when reviewing mergerequest... | {"type": "string"} |
config.json | scms | SCMs defines the list of repository configuration used to fetch content from. | {"patternProperties": {".*": {"oneOf": [{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"kind": {"enum": ["stash"]}, "spec": {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "password": {"typ... |
config.json | spec | Spec defines settings used to interact with Bitbucket release | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "password": {"type": "string"}, "owner": {"type": "string"}, "repository": {"type": "string"}, "commitmessage": {"properties": {"type": {"type": "string"}, "scope"... |
config.json | url | [S][C][T] URL specifies the default github url in case of Bitbucket enterprise | {"type": "string"} |
config.json | username | [S][C][T] Username specifies the username used to authenticate with Bitbucket API | {"type": "string"} |
config.json | token | [S][C][T] Token specifies the credential used to authenticate with | {"type": "string"} |
config.json | password | [S][C][T] Token specifies the credential used to authenticate with | {"type": "string"} |
config.json | owner | "owner" defines the owner of a repository.
compatible:
* scm | {"type": "string"} |
config.json | repository | repository specifies the name of a repository for a specific owner.
compatible:
* scm | {"type": "string"} |
config.json | commitmessage | "commitMessage" is used to generate the final commit message.
compatible:
* scm
remark:
it's worth mentioning that the commit message settings is applied to all targets linked to the same scm. | {"properties": {"type": {"type": "string"}, "scope": {"type": "string"}, "footers": {"type": "string"}, "body": {"type": "string"}, "hidecredit": {"type": "boolean"}}, "additionalProperties": false, "type": "object"} |
config.json | type | "type" defines the type of commit message such as "chore", "fix", "feat", etc. as
defined by the conventional commit specification. More information on
-> https://www.conventionalcommits.org/en/
default:
* chore | {"type": "string"} |
config.json | scope | "scope" defines the scope of the commit message as defined by the
conventional commit specification. More information on
-> https://www.conventionalcommits.org/en/
default:
none | {"type": "string"} |
config.json | footers | footers defines the footer of the commit message as defined by the
conventional commit specification. More information on
-> https://www.conventionalcommits.org/en/
default:
none | {"type": "string"} |
config.json | title | "title" defines the title of the commit message as defined by the
conventional commit specification. More information on
-> https://www.conventionalcommits.org/en/
default:
default is set to the target name or the target short description
if the name is not defined. | {"type": "string"} |
config.json | body | "body" defines the commit body of the commit message as defined by the
conventional commit specification. More information on
-> https://www.conventionalcommits.org/en/
default:
none | {"type": "string"} |
config.json | hidecredit | "hideCredit" defines if updatecli credits should be displayed inside commit message body
please consider sponsoring the Updatecli project if you want to disable credits.
-> https://github.com/updatecli/updatecli
default:
false | {"type": "boolean"} |
config.json | directory | "directory" defines the local path where the git repository is cloned.
compatible:
* scm
remark:
Unless you know what you are doing, it is recommended to use the default value.
The reason is that Updatecli may automatically clean up the directory after a pipeline execution.
default:
/tmp/updatecli/... | {"type": "string"} |
config.json | email | "email" defines the email used to commit changes.
compatible:
* scm
default:
default set to your global git configuration | {"type": "string"} |
config.json | force | "force" is used during the git push phase to run `git push --force`.
compatible:
* scm | {"type": "boolean"} |
config.json | gpg | "gpg" specifies the GPG key and passphrased used for commit signing
compatible:
* scm | {"properties": {"signingkey": {"type": "string"}, "passphrase": {"type": "string"}}, "additionalProperties": false, "type": "object"} |
config.json | signingkey | signingKey defines the gpg key used to sign the commit message
default:
none | {"type": "string"} |
config.json | passphrase | passphrase defines the gpg passphrase used to sign the commit message | {"type": "string"} |
config.json | user | "user" specifies the user associated with new git commit messages created by Updatecli
compatible:
* scm | {"type": "string"} |
config.json | branch | "branch" defines the git branch to work on.
compatible:
* scm
default:
main
remark:
depending on which resource references the Stash scm, the behavior will be different.
If the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve
file(s) from that branch.
... | {"type": "string"} |
config.json | spec | Spec contains settings to manipulate a git repository. | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "branch": {"type": "string"}, "user": {"type": "string"}, "email": {"type": "string"}, "directory": {"type": "string"}, "force": {"type": "boolean"}, "commitmes... |
config.json | url | "url" specifies the git url
compatible:
* scm
example:
* git@github.com:updatecli/updatecli.git
* https://github.com/updatecli/updatecli.git
remarks:
when using the ssh protocol, the user must have the right to clone the repository
based on its local ssh configuration | {"type": "string"} |
config.json | username | "username" specifies the username when using the HTTP protocol
compatible
* scm | {"type": "string"} |
config.json | password | "password" specifies the password when using the HTTP protocol
compatible:
* scm | {"type": "string"} |
config.json | branch | "branch" defines the git branch to work on.
compatible:
* scm
default:
main
remark:
depending on which resource references the GitHub scm, the behavior will be different.
If the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve
file(s) from that branch.... | {"type": "string"} |
config.json | user | "user" specifies the user associated with new git commit messages created by Updatecli
compatible:
* scm | {"type": "string"} |
config.json | email | "email" defines the email used to commit changes.
compatible:
* scm
default:
default set to your global git configuration | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.