schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
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 | force | "force" is used during the git push phase to run `git push --force`.
compatible:
* scm | {"type": "boolean"} |
config.json | commitmessage | "commitMessage" is used to generate the final commit message.
compatible:
* scm
remark:
it's worth mentioning that the commit message is applied to all targets linked to the same scm.
default:
false | {"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 | 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 | spec | Spec defines settings used to interact with Gitea release | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "commitmessage": {"properties": {"type": {"type": "string"}, "scope": {"type": "string"}, "footers": {"type": "string"}, "body": {"type": "string"}, "hidecredit": ... |
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 | 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 | 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 | 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 Gitea 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 represents the configuration input | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"branch": {"type": "string"}, "directory": {"type": "string"}, "email": {"type": "string"}, "owner": {"type": "string"}, "repository": {"type": "string"}, "token": {"type": "string"}, "url": {"type": "string"}, "username": {"type": "string"}, "user": ... |
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 | 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 | 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 | token | "token" specifies the credential used to authenticate with GitHub API.
compatible:
* scm | {"type": "string"} |
config.json | url | url specifies the default github url in case of GitHub enterprise
compatible:
* scm
default:
github.com | {"type": "string"} |
config.json | username | "username" specifies the username used to authenticate with GitHub API.
compatible:
* scm
remark:
the token is usually enough to authenticate with GitHub API. | {"type": "string"} |
config.json | user | "user" specifies the user associated with new git commit messages created by Updatecli
compatible:
* scm | {"type": "string"} |
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 | force | "force" is used during the git push phase to run `git push --force`.
compatible:
* scm
default:
false | {"type": "boolean"} |
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 | spec | Spec defines settings used to interact with GitLab release | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "commitmessage": {"properties": {"type": {"type": "string"}, "scope": {"type": "string"}, "footers": {"type": "string"}, "body": {"type": "string"}, "hidecredit": ... |
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 | 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
default:
false | {"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 | 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:
* action
* scm | {"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 GitLab 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 | sources | Sources defines the list of source configuration | {"patternProperties": {".*": {"oneOf": [{"$schema": "http://json-schema.org/draft-04/schema", "properties": {"dependson": {"items": {"type": "string"}, "type": "array"}, "name": {"type": "string"}, "kind": {"enum": ["gitlab/branch"]}, "transformers": {"items": {"properties": {"addprefix": {"type": "string"}, "addsuffix... |
config.json | dependson | dependson specifies which resources must be executed before the current one | {"items": {"type": "string"}, "type": "array"} |
config.json | name | name specifies the resource name | {"type": "string"} |
config.json | transformers | transformers defines how the default input value need to be transformed | {"items": {"properties": {"addprefix": {"type": "string"}, "addsuffix": {"type": "string"}, "trimprefix": {"type": "string"}, "trimsuffix": {"type": "string"}, "replacers": {"items": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["fro... |
config.json | items | Transformer holds a transformer rule | {"properties": {"addprefix": {"type": "string"}, "addsuffix": {"type": "string"}, "trimprefix": {"type": "string"}, "trimsuffix": {"type": "string"}, "replacers": {"items": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}... |
config.json | addprefix | AddPrefix adds a prefix to the transformer input value | {"type": "string"} |
config.json | addsuffix | AddSuffix adds a suffix to the transformer input value | {"type": "string"} |
config.json | trimprefix | TrimPrefix removes a prefix to the transformer input value | {"type": "string"} |
config.json | trimsuffix | TrimSuffix removes the suffix from the transformer input value | {"type": "string"} |
config.json | replacers | Replacers specifies a list of replacer instruction | {"items": {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]}, "type": "array"} |
config.json | items | Replacer is struct used to feed strings.Replacer | {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]} |
config.json | from | From defines the source value which need to be replaced | {"type": "string"} |
config.json | to | To defines the "to what" a "from" value needs to be replaced | {"type": "string"} |
config.json | replacer | Replacer specifies what value needs to be changed and how | {"properties": {"from": {"type": "string"}, "to": {"type": "string"}}, "additionalProperties": false, "type": "object", "required": ["from", "to"]} |
config.json | from | From defines the source value which need to be replaced | {"type": "string"} |
config.json | to | To defines the "to what" a "from" value needs to be replaced | {"type": "string"} |
config.json | find | Find searches for a specific value if it exists and return false if it doesn't | {"type": "string"} |
config.json | findsubmatch | Find searches for a specific value if it exists then return the value using regular expression | {"properties": {"pattern": {"type": "string"}, "captureindex": {"type": "integer"}}, "additionalProperties": false, "type": "object", "required": ["pattern"]} |
config.json | pattern | Pattern defines regular expression to use for retrieving a submatch | {"type": "string"} |
config.json | captureindex | CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`. | {"type": "integer"} |
config.json | semverinc | SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded. | {"type": "string"} |
config.json | spec | Spec defines settings used to interact with GitLab release | {"$schema": "http://json-schema.org/draft-04/schema", "properties": {"url": {"type": "string"}, "username": {"type": "string"}, "token": {"type": "string"}, "owner": {"type": "string"}, "repository": {"type": "string"}, "versionfilter": {"properties": {"kind": {"type": "string"}, "pattern": {"type": "string"}, "strict"... |
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"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.