Skip to content

Commit f29b40e

Browse files
updateclibot[bot]updatecli
updateclibot[bot]
and
updatecli
authored
chore: chore: update Updatecli jsonschema (#2102)
Made with ❤️️ by updatecli Co-authored-by: updatecli <updatecli@olblak.com>
1 parent 379f10c commit f29b40e

File tree

2 files changed

+30
-36
lines changed

2 files changed

+30
-36
lines changed

‎content/en/schema/latest/config.json‎

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7906,8 +7906,7 @@
79067906
"$schema": "http://json-schema.org/draft-04/schema",
79077907
"properties": {
79087908
"command": {
7909-
"type": "string",
7910-
"description": "command specifies the shell command to execute by Updatecli"
7909+
"type": "string"
79117910
},
79127911
"environments": {
79137912
"items": {
@@ -7929,7 +7928,7 @@
79297928
"description": "Environment is a struct containing information for an environment variable such as its name and its value"
79307929
},
79317930
"type": "array",
7932-
"description": "environments allows to pass environment variable(s) to the shell script. By default no environment variable are shared."
7931+
"description": "environments allows to pass environment variable(s) to the shell script.\n\n default:\n If environments is unset then it depends on the operating system.\n - Windows: [\"PATH\",\"\", \"PSModulePath\", \"PSModuleAnalysisCachePath\", \"\", \"PATHEXT\", \"\", \"TEMP\", \"\", \"HOME\", \"\", \"USERPROFILE\", \"\", \"PROFILE\"]\n - Darwin/Linux: [\"PATH\", \"\", \"HOME\", \"\", \"USER\", \"\", \"LOGNAME\", \"\", \"SHELL\", \"\", \"LANG\", \"\", \"LC_ALL\"]\n\nremark:\n For security reason, Updatecli doesn't pass the entire environment to the shell command but instead works\n with an allow list of environment variables."
79337932
},
79347933
"changedif": {
79357934
"oneOf": [
@@ -8012,15 +8011,15 @@
80128011
"type": "object"
80138012
}
80148013
],
8015-
"description": "ChangedIf defines how to interpreted shell command success criteria. What a success means, what an error means, and what a warning would mean"
8014+
"description": "ChangedIf defines how to interpret shell command execution.\nWhat a success means, what an error means, and what a warning would mean in the context of Updatecli.\n\nPlease note that in the context of Updatecli,\n - a success means nothing changed\n - a warning means something changed\n - an error means something went wrong\n\nChangedif can be of kind \"exitcode\", \"console/output\", or \"file/checksum\"\n\n \"console/output\" (default)\n Check the output of the command to identify if Updatecli should report a success, a warning, or an error.\n If a target returns anything to stdout, Updatecli interprets it as a something changed, otherwise it's a success.\n\n example:\n\n ---\n targets:\n default:\n name: 'doc: synchronize release note'\n kind: 'shell'\n disablesourceinput: true\n spec:\n command: 'releasepost --dry-run=\"$DRY_RUN\" --config {{ .config }} --clean'\n ---\n\n \"exitcode\":\n Check the exit code of the command to identify if Updatecli should report a success, a warning, or an error.\n\n example:\n\n ---\n targets:\n default:\n name: 'doc: synchronize release note'\n kind: 'shell'\n disablesourceinput: true\n spec:\n command: 'releasepost --dry-run=\"$DRY_RUN\" --config {{ .config }} --clean'\n environments:\n - name: 'GITHUB_TOKEN'\n - name: 'PATH'\n changedif:\n kind: 'exitcode'\n spec:\n warning: 0\n success: 1\n failure: 2\n ---\n\n \"file/checksum\":\n Check the checksum of file(s) to identify if Updatecli should report a success, a warning, or an error.\n\n example:\n\n ---\n targets:\n default:\n disablesourceinput: true\n name: Example of a shell command with a checksum success criteria\n kind: shell\n spec:\n command: |\n \t \t yq -i '.a.b[0].c = \"cool\"' file.yaml\n changedif:\n kind: file/checksum\n spec:\n files:\n - file.yaml\n ---"
80168015
},
80178016
"shell": {
80188017
"type": "string",
8019-
"description": "Shell specifies which shell interpreter to use. Default to powershell(Windows) and \"/bin/sh\" (Darwin/Linux)"
8018+
"description": "Shell specifies which shell interpreter to use.\n\ndefault:\n Depends on the operating system:\n - Windows: \"powershell\"\n - Darwin/Linux: \"/bin/sh\""
80208019
},
80218020
"workdir": {
80228021
"type": "string",
8023-
"description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path."
8022+
"description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path.\n\ndefault: If a scmid is specified then the default"
80248023
}
80258024
},
80268025
"additionalProperties": false,
@@ -14929,8 +14928,7 @@
1492914928
"$schema": "http://json-schema.org/draft-04/schema",
1493014929
"properties": {
1493114930
"command": {
14932-
"type": "string",
14933-
"description": "command specifies the shell command to execute by Updatecli"
14931+
"type": "string"
1493414932
},
1493514933
"environments": {
1493614934
"items": {
@@ -14952,7 +14950,7 @@
1495214950
"description": "Environment is a struct containing information for an environment variable such as its name and its value"
1495314951
},
1495414952
"type": "array",
14955-
"description": "environments allows to pass environment variable(s) to the shell script. By default no environment variable are shared."
14953+
"description": "environments allows to pass environment variable(s) to the shell script.\n\n default:\n If environments is unset then it depends on the operating system.\n - Windows: [\"PATH\",\"\", \"PSModulePath\", \"PSModuleAnalysisCachePath\", \"\", \"PATHEXT\", \"\", \"TEMP\", \"\", \"HOME\", \"\", \"USERPROFILE\", \"\", \"PROFILE\"]\n - Darwin/Linux: [\"PATH\", \"\", \"HOME\", \"\", \"USER\", \"\", \"LOGNAME\", \"\", \"SHELL\", \"\", \"LANG\", \"\", \"LC_ALL\"]\n\nremark:\n For security reason, Updatecli doesn't pass the entire environment to the shell command but instead works\n with an allow list of environment variables."
1495614954
},
1495714955
"changedif": {
1495814956
"oneOf": [
@@ -15035,15 +15033,15 @@
1503515033
"type": "object"
1503615034
}
1503715035
],
15038-
"description": "ChangedIf defines how to interpreted shell command success criteria. What a success means, what an error means, and what a warning would mean"
15036+
"description": "ChangedIf defines how to interpret shell command execution.\nWhat a success means, what an error means, and what a warning would mean in the context of Updatecli.\n\nPlease note that in the context of Updatecli,\n - a success means nothing changed\n - a warning means something changed\n - an error means something went wrong\n\nChangedif can be of kind \"exitcode\", \"console/output\", or \"file/checksum\"\n\n \"console/output\" (default)\n Check the output of the command to identify if Updatecli should report a success, a warning, or an error.\n If a target returns anything to stdout, Updatecli interprets it as a something changed, otherwise it's a success.\n\n example:\n\n ---\n targets:\n default:\n name: 'doc: synchronize release note'\n kind: 'shell'\n disablesourceinput: true\n spec:\n command: 'releasepost --dry-run=\"$DRY_RUN\" --config {{ .config }} --clean'\n ---\n\n \"exitcode\":\n Check the exit code of the command to identify if Updatecli should report a success, a warning, or an error.\n\n example:\n\n ---\n targets:\n default:\n name: 'doc: synchronize release note'\n kind: 'shell'\n disablesourceinput: true\n spec:\n command: 'releasepost --dry-run=\"$DRY_RUN\" --config {{ .config }} --clean'\n environments:\n - name: 'GITHUB_TOKEN'\n - name: 'PATH'\n changedif:\n kind: 'exitcode'\n spec:\n warning: 0\n success: 1\n failure: 2\n ---\n\n \"file/checksum\":\n Check the checksum of file(s) to identify if Updatecli should report a success, a warning, or an error.\n\n example:\n\n ---\n targets:\n default:\n disablesourceinput: true\n name: Example of a shell command with a checksum success criteria\n kind: shell\n spec:\n command: |\n \t \t yq -i '.a.b[0].c = \"cool\"' file.yaml\n changedif:\n kind: file/checksum\n spec:\n files:\n - file.yaml\n ---"
1503915037
},
1504015038
"shell": {
1504115039
"type": "string",
15042-
"description": "Shell specifies which shell interpreter to use. Default to powershell(Windows) and \"/bin/sh\" (Darwin/Linux)"
15040+
"description": "Shell specifies which shell interpreter to use.\n\ndefault:\n Depends on the operating system:\n - Windows: \"powershell\"\n - Darwin/Linux: \"/bin/sh\""
1504315041
},
1504415042
"workdir": {
1504515043
"type": "string",
15046-
"description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path."
15044+
"description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path.\n\ndefault: If a scmid is specified then the default"
1504715045
}
1504815046
},
1504915047
"additionalProperties": false,
@@ -22294,8 +22292,7 @@
2229422292
"$schema": "http://json-schema.org/draft-04/schema",
2229522293
"properties": {
2229622294
"command": {
22297-
"type": "string",
22298-
"description": "command specifies the shell command to execute by Updatecli"
22295+
"type": "string"
2229922296
},
2230022297
"environments": {
2230122298
"items": {
@@ -22317,7 +22314,7 @@
2231722314
"description": "Environment is a struct containing information for an environment variable such as its name and its value"
2231822315
},
2231922316
"type": "array",
22320-
"description": "environments allows to pass environment variable(s) to the shell script. By default no environment variable are shared."
22317+
"description": "environments allows to pass environment variable(s) to the shell script.\n\n default:\n If environments is unset then it depends on the operating system.\n - Windows: [\"PATH\",\"\", \"PSModulePath\", \"PSModuleAnalysisCachePath\", \"\", \"PATHEXT\", \"\", \"TEMP\", \"\", \"HOME\", \"\", \"USERPROFILE\", \"\", \"PROFILE\"]\n - Darwin/Linux: [\"PATH\", \"\", \"HOME\", \"\", \"USER\", \"\", \"LOGNAME\", \"\", \"SHELL\", \"\", \"LANG\", \"\", \"LC_ALL\"]\n\nremark:\n For security reason, Updatecli doesn't pass the entire environment to the shell command but instead works\n with an allow list of environment variables."
2232122318
},
2232222319
"changedif": {
2232322320
"oneOf": [
@@ -22400,15 +22397,15 @@
2240022397
"type": "object"
2240122398
}
2240222399
],
22403-
"description": "ChangedIf defines how to interpreted shell command success criteria. What a success means, what an error means, and what a warning would mean"
22400+
"description": "ChangedIf defines how to interpret shell command execution.\nWhat a success means, what an error means, and what a warning would mean in the context of Updatecli.\n\nPlease note that in the context of Updatecli,\n - a success means nothing changed\n - a warning means something changed\n - an error means something went wrong\n\nChangedif can be of kind \"exitcode\", \"console/output\", or \"file/checksum\"\n\n \"console/output\" (default)\n Check the output of the command to identify if Updatecli should report a success, a warning, or an error.\n If a target returns anything to stdout, Updatecli interprets it as a something changed, otherwise it's a success.\n\n example:\n\n ---\n targets:\n default:\n name: 'doc: synchronize release note'\n kind: 'shell'\n disablesourceinput: true\n spec:\n command: 'releasepost --dry-run=\"$DRY_RUN\" --config {{ .config }} --clean'\n ---\n\n \"exitcode\":\n Check the exit code of the command to identify if Updatecli should report a success, a warning, or an error.\n\n example:\n\n ---\n targets:\n default:\n name: 'doc: synchronize release note'\n kind: 'shell'\n disablesourceinput: true\n spec:\n command: 'releasepost --dry-run=\"$DRY_RUN\" --config {{ .config }} --clean'\n environments:\n - name: 'GITHUB_TOKEN'\n - name: 'PATH'\n changedif:\n kind: 'exitcode'\n spec:\n warning: 0\n success: 1\n failure: 2\n ---\n\n \"file/checksum\":\n Check the checksum of file(s) to identify if Updatecli should report a success, a warning, or an error.\n\n example:\n\n ---\n targets:\n default:\n disablesourceinput: true\n name: Example of a shell command with a checksum success criteria\n kind: shell\n spec:\n command: |\n \t \t yq -i '.a.b[0].c = \"cool\"' file.yaml\n changedif:\n kind: file/checksum\n spec:\n files:\n - file.yaml\n ---"
2240422401
},
2240522402
"shell": {
2240622403
"type": "string",
22407-
"description": "Shell specifies which shell interpreter to use. Default to powershell(Windows) and \"/bin/sh\" (Darwin/Linux)"
22404+
"description": "Shell specifies which shell interpreter to use.\n\ndefault:\n Depends on the operating system:\n - Windows: \"powershell\"\n - Darwin/Linux: \"/bin/sh\""
2240822405
},
2240922406
"workdir": {
2241022407
"type": "string",
22411-
"description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path."
22408+
"description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path.\n\ndefault: If a scmid is specified then the default"
2241222409
}
2241322410
},
2241422411
"additionalProperties": false,

0 commit comments

Comments
 (0)