Skip to content

docs: update Updatecli jsonschema #3068

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
May 5, 2026
Merged

docs: update Updatecli jsonschema #3068

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
11 changes: 11 additions & 0 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 @@ -6,6 +6,17 @@
"type": "string",
"description": "\"name\" defines a pipeline name\n\nexample:\n\t* \"name: 'deps: update nodejs version to latest stable'\"\n\nremark:\n\t* using a short sentence describing the pipeline is a good way to name your pipeline.\n\t* using conventional commits convention is a good way to name your pipeline.\n\t* \"name\" is often used a default values for other configuration such as pullrequest title.\n\t* \"name\" shouldn't contain any dynamic information such as source output."
},
"id": {
"type": "string",
"description": "\"id\" defines a manifest dependency identifier that can be referenced by other manifests.\n\nexample:\n\t* \"id: nodejs\"\n\t* \"id: docker/alpine\"\n\nremark:\n\t* \"id\" only affects manifest execution ordering.\n\t* \"id\" is used by the root manifest \"dependson\" keyword.\n\t* multiple manifests may intentionally share the same \"id\".\n\t* unlike \"pipelineid\", \"id\" does not affect branch naming or workflow grouping."
},
"dependson": {
"items": {
"type": "string"
},
"type": "array",
"description": "\"dependson\" defines which manifest IDs must run before the current manifest.\n\nexample:\n---\ndependson:\n - base-images\n - shared-policies\n---\n\nremark:\n\t* entries reference root manifest \"id\" values.\n\t* if multiple manifests share the same \"id\" then all of them must run first.\n\t* \"dependson\" only affects manifest execution ordering."
},
"pipelineid": {
"type": "string",
"description": "\"pipelineid\" allows to identify a full pipeline run.\n\nexample:\n\t* \"pipelineid: nodejs/dependencies\"\n\t* \"pipelineid: gomod/github.com/updatecli/updatecli\"\n\t* \"pipelineid: autodiscovery/gomodules/minor\"\n\nremark:\n\t* \"pipelineid\" is used to generate uniq branch name for target update relying on scm configuration.\n\t* The same \"pipelineid\" may be used by different Updatecli manifest\" to ensure they are updated in the same workflow including pullrequest."
Expand Down
Loading