Skip to content

docs: update Updatecli jsonschema #2772

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
updateclibot merged 1 commit into from
Mar 27, 2026
Merged

docs: update Updatecli jsonschema #2772

Show file tree
Hide file tree
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
24 changes: 1 addition & 23 deletions content/en/schema/latest/compose/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
"$schema": "http://json-schema.org/draft-04/schema",
"$id": "https://www.updatecli.io/latest/schema/compose/spec",
"properties": {
"name": {
"type": "string",
"description": "Name contains the compose name"
},
"policies": {
"items": {
"properties": {
Expand All @@ -31,10 +27,6 @@
"type": "array",
"description": "Values contains a list of Updatecli config file path"
},
"valuesinline": {
"type": "object",
"description": "ValuesInline contains a list of inline values for Updatecli config\nA deep merge will be performed between global inline values and policy inline values if both are defined.\n\nExample:\n key1: value1\n key2: value2"
},
"secrets": {
"items": {
"type": "string"
Expand Down Expand Up @@ -62,22 +54,8 @@
},
"type": "array",
"description": "Env_files contains a list of environment files\n\nExample:\n - env_file1.env\n - env_file2.env"
},
"valuesinline": {
"type": "object",
"description": "ValuesInline contains a list of inline values for Updatecli config\nThis is the default inline values that will be applied to all policies if not overridden by the policy inline values.\nA deep merge will be performed between global inline values and policy inline values if both are defined.\n\nExample:\n key1: value1\n key2: value2"
},
"include": {
"items": {
"type": "string"
},
"type": "array",
"description": "Include contains a list of compose files to include"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
]
"type": "object"
}
152 changes: 0 additions & 152 deletions content/en/schema/latest/policy/manifest/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4078,10 +4078,6 @@
"spec": {
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"depth": {
"type": "integer",
"description": "Depth defines the depth used when cloning the git repository.\n\nDefault: disabled (full clone)\n\nRemark:\n When using a shallow clone (depth greater than 0), Updatecli is not able to retrieve the full git history.\n This may cause some issues when Updatecli tries to push changes to the remote repository.\n In that case, you may need to set the force option to true to force push changes to the remote repository."
},
"limit": {
"type": "integer",
"description": "Limit defines the maximum number of repositories to return from the search query.\n\ncompatible:\n * scm\n\ndefault:\n 10\n\nremark:\n If limit is set to 0, all repositories matching the search query will be returned."
Expand Down Expand Up @@ -4379,154 +4375,6 @@
"additionalProperties": false,
"type": "object"
},
{
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"kind": {
"enum": [
"gitlabsearch"
]
},
"spec": {
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"url": {
"type": "string",
"description": "\"url\" defines the GitLab url to interact with\n\n default:\n \"gitlab.com\""
},
"username": {
"type": "string",
"description": "\"username\" defines the username used to authenticate with GitLab"
},
"token": {
"type": "string",
"description": "\"token\" defines the credential used to authenticate with GitLab\n\n remark:\n A token is a sensitive information, it's recommended to not set this value directly in the configuration file\n but to use an environment variable or a SOPS file.\n\n The value can be set to `{{ requiredEnv \"GITLAB_TOKEN\"}}` to retrieve the token from the environment variable `GITLAB_TOKEN`\n\t or `{{ .gitlab.token }}` to retrieve the token from a SOPS file.\n\n\t For more information, about a SOPS file, please refer to the following documentation:\n https://github.com/getsops/sops"
},
"group": {
"type": "string",
"description": "\"group\" defines the GitLab group (or subgroup) to search repositories in.\n\ncompatible:\n * scm\n\nremark:\n Supports nested groups using slash notation, e.g. \"myorg/myteam\"."
},
"search": {
"type": "string",
"description": "\"search\" filters the repository list by name.\n\ncompatible:\n * scm\n\nremark:\n When omitted, all projects in the group are returned."
},
"includesubgroups": {
"type": "boolean",
"description": "\"includeSubgroups\" defines whether projects from subgroups should be included in the search results.\n\ncompatible:\n * scm\n\ndefault:\n true"
},
"limit": {
"type": "integer",
"description": "Limit defines the maximum number of repositories to return.\n\ncompatible:\n * scm\n\ndefault:\n 10\n\nremark:\n If limit is set to 0, all repositories matching the query will be returned."
},
"branch": {
"type": "string",
"description": "\"branch\" defines the git branch to work on.\n\ncompatible:\n * scm\n\ndefault:\n ^main$\n\nremark:\n The branch value is a regular expression used to match branches across the discovered repositories.\n\n If the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve\n file(s) from that branch.\n\n If the scm is linked to a target then Updatecli creates a new \"working branch\" based on the branch value.\n The working branch created by Updatecli looks like \"updatecli_\u003cpipelineID\u003e\".\n The working branch can be disabled using the \"workingBranch\" parameter set to false."
},
"workingbranchprefix": {
"type": "string",
"description": "WorkingBranchPrefix defines the prefix used to create a working branch.\n\ncompatible:\n * scm\n\ndefault:\n updatecli\n\nremark:\n A working branch is composed of three components:\n 1. WorkingBranchPrefix\n 2. Target Branch\n 3. PipelineID\n\n If WorkingBranchPrefix is set to '', then\n the working branch will look like \"\u003cbranch\u003e_\u003cpipelineID\u003e\"."
},
"workingbranchseparator": {
"type": "string",
"description": "WorkingBranchSeparator defines the separator used to create a working branch.\n\ncompatible:\n * scm\n\ndefault:\n \"_\""
},
"directory": {
"type": "string",
"description": "\"directory\" defines the local path where the git repository is cloned.\n\ncompatible:\n * scm\n\nremark:\n Unless you know what you are doing, it is recommended to use the default value.\n The reason is that Updatecli may automatically clean up the directory after a pipeline execution.\n\ndefault:\n The default value is based on your local temporary directory like: (on Linux)\n /tmp/updatecli/gitlab/\u003cowner\u003e/\u003crepository\u003e"
},
"depth": {
"type": "integer",
"description": "Depth defines the depth used when cloning the git repository.\n\nDefault: disabled (full clone)\n\nRemark:\n When using a shallow clone (depth greater than 0), Updatecli is not able to retrieve the full git history.\n This may cause some issues when Updatecli tries to push changes to the remote repository.\n In that case, you may need to set the force option to true to force push changes to the remote repository."
},
"email": {
"type": "string",
"description": "\"email\" defines the email used to commit changes.\n\ncompatible:\n * scm\n\ndefault:\n default set to your global git configuration"
},
"user": {
"type": "string",
"description": "\"user\" specifies the user associated with new git commit messages created by Updatecli\n\ncompatible:\n * scm"
},
"gpg": {
"properties": {
"signingkey": {
"type": "string",
"description": "signingKey defines the gpg key used to sign the commit message\n\n\t\tdefault:\n\t\t\tnone"
},
"passphrase": {
"type": "string",
"description": "passphrase defines the gpg passphrase used to sign the commit message"
}
},
"additionalProperties": false,
"type": "object",
"description": "\"gpg\" specifies the GPG key and passphrase used for commit signing\n\ncompatible:\n * scm"
},
"force": {
"type": "boolean",
"description": "\"force\" is used during the git push phase to run `git push --force`.\n\ncompatible:\n * scm\n\ndefault:\n true\n\nremark:\n When force is set to true, Updatecli also recreates the working branches that\n diverged from their base branch."
},
"commitmessage": {
"properties": {
"type": {
"type": "string",
"description": "type defines the type of commit message such as \"chore\", \"fix\", \"feat\", etc. as\n defined by the conventional commit specification. More information on\n -\u003e https://www.conventionalcommits.org/en/\n\n default:\n * chore"
},
"scope": {
"type": "string",
"description": "scope defines the scope of the commit message as defined by the\n conventional commit specification. More information on\n -\u003e https://www.conventionalcommits.org/en/\n\n default:\n none"
},
"footers": {
"type": "string",
"description": "footers defines the footer of the commit message as defined by the\n conventional commit specification. More information on\n -\u003e https://www.conventionalcommits.org/en/\n\n default:\n none"
},
"title": {
"type": "string",
"description": "Title is the parsed commit message title (not configurable via YAML).\n The title is automatically generated from the target name or description."
},
"deprecatedtitle": {
"type": "string",
"description": "DeprecatedTitle is deprecated and will be ignored.\n The commit title is now always generated from the target name or description."
},
"body": {
"type": "string",
"description": "body defines the commit body of the commit message as defined by the\n conventional commit specification. More information on\n -\u003e https://www.conventionalcommits.org/en/\n\n default:\n none"
},
"hidecredit": {
"type": "boolean",
"description": "hideCredit defines if updatecli credits should be displayed inside commit message body\n\n please consider sponsoring the Updatecli project if you want to disable credits.\n -\u003e https://github.com/updatecli/updatecli\n\n default:\n \tfalse"
},
"squash": {
"type": "boolean",
"description": "squash defines if the commit should be squashed\n\n default:\n \tfalse\n\n important:\n if squash is set to true, then it's highly recommended to set the commit body\n to a meaningful value as all other commit information will be lost during the squash operation.\n\n if body is not set, then the commit title/message will be generated based on the most recent commit\n message of the squashed commits. The commit title is always generated from the target name or description."
}
},
"additionalProperties": false,
"type": "object",
"description": "\"commitMessage\" is used to generate the final commit message.\n\ncompatible:\n * scm\n\nremark:\n it's worth mentioning that the commit message settings is applied to all targets linked to the same scm."
},
"submodules": {
"type": "boolean",
"description": "\"submodules\" defines if Updatecli should checkout submodules.\n\ncompatible:\n * scm\n\ndefault: true"
},
"workingbranch": {
"type": "boolean",
"description": "\"workingBranch\" defines if Updatecli should use a temporary branch to work on.\nIf set to `true`, Updatecli create a temporary branch to work on, based on the branch value.\n\ncompatible:\n * scm\n\ndefault: true"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"group"
],
"description": "Spec represents the configuration input for the gitlabsearch SCM."
},
"disabled": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
{
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
Expand Down
Loading