Skip to content
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

(GH-178) Document dsc exit codes #179

Merged
merged 2 commits into from
Sep 1, 2023
Merged

(GH-178) Document dsc exit codes #179

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22c8b40
(GH-178) Document `dsc` exit codes
michaeltlombardi Aug 30, 2023
d115b00
Merge branch 'main' into gh-178/main/exit-codes
SteveL-MSFT Sep 1, 2023
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
15 changes: 15 additions & 0 deletions docs/reference/cli/dsc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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