Merge branch 'main' into maint/main/update-osinfo-docs

PowerShell · Sep 1, 2023 · 7d88872 · 7d88872
2 parents 800172c + fb3ef20
commit 7d88872
Show file tree

Hide file tree

Showing 50 changed files with 2,719 additions and 863 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -11,5 +11,15 @@
         "./test_group_resource/Cargo.toml",
         "./y2j/Cargo.toml"
     ],
-    "rust-analyzer.showUnlinkedFileNotification": true
+    "rust-analyzer.showUnlinkedFileNotification": true,
+    "json.schemas": [
+        {
+            "fileMatch": ["**/*.dsc.resource.json"],
+            "url": "/schemas/2023/08/bundled/resource/manifest.vscode.json"
+        }
+    ],
+    "yaml.schemas": {
+        "schemas/2023/08/bundled/config/document.vscode.json": "**.dsc.{yaml,yml,config.yaml,config.yml}",
+        "schemas/2023/08/bundled/resource/manifest.vscode.json": "**.dsc.resource.{yaml,yml}"
+    }
 }
diff --git a/docs/reference/cli/dsc.md b/docs/reference/cli/dsc.md
@@ -102,6 +102,21 @@ Type:      Boolean
 Mandatory: false
 ```
 
+## Exit Codes
+
+The `dsc` command uses semantic exit codes. Each exit code represents a different result for the
+execution of the command.
+
+| Exit Code |                                                 Meaning                                                 |
+| :-------: | :------------------------------------------------------------------------------------------------------ |
+|    `0`    | The command executed successfully without any errors.                                                   |
+|    `1`    | The command failed because it received invalid arguments.                                               |
+|    `2`    | The command failed because a resource raised an error.                                                  |
+|    `3`    | The command failed because a value couldn't be serialized to or deserialized from JSON.                 |
+|    `4`    | The command failed because input for the command wasn't valid YAML or JSON.                             |
+|    `5`    | The command failed because a resource definition or instance value was invalid against its JSON schema. |
+|    `6`    | The command was cancelled by a <kbd>Ctrl</kbd>+<kbd>C</kbd> interruption.                               |
+
 [01]: config/command.md
 [02]: resource/command.md
 [03]: schema/command.md
diff --git a/dsc/assertion.dsc.resource.json b/dsc/assertion.dsc.resource.json
@@ -31,7 +31,13 @@
     "return": "state"
   },
   "exitCodes": {
-    "0": "Success"
+    "0": "Success",
+    "1": "Invalid argument",
+    "2": "Resource error",
+    "3": "JSON Serialization error",
+    "4": "Invalid input format",
+    "5": "Resource instance failed schema validation",
+    "6": "Command cancelled"
   },
   "schema": {
     "command": {

diff --git a/dsc/group.dsc.resource.json b/dsc/group.dsc.resource.json
@@ -31,7 +31,13 @@
     "return": "state"
   },
   "exitCodes": {
-    "0": "Success"
+    "0": "Success",
+    "1": "Invalid argument",
+    "2": "Resource error",
+    "3": "JSON Serialization error",
+    "4": "Invalid input format",
+    "5": "Resource instance failed schema validation",
+    "6": "Command cancelled"
   },
   "validate": {
     "executable": "dsc",

diff --git a/dsc/parallel.dsc.resource.json b/dsc/parallel.dsc.resource.json
@@ -34,7 +34,13 @@
     "return": "state"
   },
   "exitCodes": {
-    "0": "Success"
+    "0": "Success",
+    "1": "Invalid argument",
+    "2": "Resource error",
+    "3": "JSON Serialization error",
+    "4": "Invalid input format",
+    "5": "Resource instance failed schema validation",
+    "6": "Command cancelled"
   },
   "validate": {
     "executable": "dsc",