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.

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

Expected return codes #1278

Closed
denelon opened this issue Jul 13, 2021 · 1 comment · Fixed by #1421
Closed

Expected return codes #1278

denelon opened this issue Jul 13, 2021 · 1 comment · Fixed by #1421
Assignees
Labels
Area-Manifest This may require a change to the manifest Issue-Feature This is a feature request for the Windows Package Manager client.
Milestone

Comments

@denelon
Copy link
Contributor

denelon commented Jul 13, 2021

Description of the new feature/enhancement

Some .exe installers provide return error codes for known reasons on install. These aren't exactly the same as "SuccessCodes" because the install didn't complete, but they aren't necessarily catastrophic failures either.

We would like to be able to have standard known error messages that can be easily understood and localized for these installers.

Proposed technical implementation details (optional)

The Windows Package Manager would have an enumeration of responses to be localized for mapping to specific return codes from installers.

For example some packages return error codes indicating the program is in use and should be exited before install.

OBS Studio returns "5" when the package is already running.

Installers:
  - InstallerType: exe
    InstallerArchitecture: x64
    InstallerSHA256: 12341234123412341234123412341234123412341234
    InstallerURL: https://www.contoso.com/awesomeapp/1.0.0/awesomeapp.x64.exe
    EpectedReturnCodes:
      - InstallerReturnCode: 5
        ReturnResponse: PACKAGE_IN_USE
@denelon denelon added Issue-Feature This is a feature request for the Windows Package Manager client. Area-Manifest This may require a change to the manifest labels Jul 13, 2021
@ghost ghost added the Needs-Triage Issue need to be triaged label Jul 13, 2021
@denelon denelon removed the Needs-Triage Issue need to be triaged label Jul 13, 2021
@denelon denelon added this to the v.Next - Windows Package Manager milestone Jul 14, 2021
@denelon denelon linked a pull request Oct 1, 2021 that will close this issue
@denelon denelon added this to WinGet Oct 1, 2021
@denelon
Copy link
Contributor Author

denelon commented Oct 1, 2021

This will not be supported fully until the validation pipelines accept the 1.1 schema.

"ExpectedReturnCodes": {
"type": [ "array", "null" ],
"items": {
"type": "object",
"properties": {
"InstallerReturnCode": {
"$ref": "#/definitions/InstallerReturnCode"
},
"ReturnResponse": {
"type": "string",
"enum": [
"packageInUse",
"installInProgress",
"fileInUse",
"missingDependency",
"diskFull",
"insufficientMemory",
"noNetwork",
"contactSupport",
"rebootRequiredToFinish",
"rebootRequiredForInstall",
"rebootInitiated",
"cancelledByUser",
"alreadyInstalled",
"downgrade",
"blockedByPolicy"
]
}
}
},
"maxItems": 128,
"description": "Installer exit codes for common errors"
},

@denelon denelon modified the milestones: v.Next-Client, v1.2-Client Dec 1, 2021
@denelon denelon closed this as completed Dec 1, 2021
Repository owner moved this from In Progress to Done in WinGet Dec 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Manifest This may require a change to the manifest Issue-Feature This is a feature request for the Windows Package Manager client.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants