Fix App Installer UpdateUris/RepairUris element docs - #492
Fix App Installer UpdateUris/RepairUris element docs#492Roy (RDMacLachlan) wants to merge 3 commits into
Conversation
Correct the App Installer auto-update/repair element documentation to match the authoritative appinstaller schema: - Fix element casing UpdateURIs/UpdateURI/RepairURIs/RepairURI to the canonical UpdateUris/UpdateUri/RepairUris/RepairUri (XML is case-sensitive). - Fix the schema-invalid overview example that declared the 2017/2 namespace while using 2021-only elements; use the 2021 namespace and order UpdateSettings before UpdateUris/RepairUris. - Fix the copy-paste "Automatic Repair" table that documented UpdateURI instead of RepairUri. - Cross-link the s4:UpdateUris/UpdateUri/RepairUris/RepairUri schema reference pages. Resolves AB#37966117 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Learn Build status updates of commit e961722: ✅ Validation status: passed
For more details, please refer to the build report. |
Wrap the UpdateUris/UpdateUri/RepairUri element-name links in backticks so they match the code-formatted RepairUris link and the file's convention of using backticks for element names. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 18e32334-aec6-40fd-a4f8-0631ef4d5840
|
Learn Build status updates of commit 9ae3ffa: ✅ Validation status: passed
For more details, please refer to the build report. |
| ## Automatic updates | ||
|
|
||
| Windows apps will use their App Installer URI path to check for Windows app updates, however if the App Installer URI is inaccessible the Windows app will check for updates using the UpdateURIs, attempting to connect to each before attempting the next. The first App Installer file to be accessible will be validated against checking for any new Windows app updates. | ||
| Windows apps will use their App Installer URI path to check for Windows app updates, however if the App Installer URI is inaccessible the Windows app will check for updates using the [`UpdateUris`](/uwp/schemas/appinstallerschema/element-s4-updateuris), attempting to connect to each before attempting the next. The first App Installer file to be accessible will be validated against checking for any new Windows app updates. |
There was a problem hiding this comment.
paths. The .appinstaller file supports multiple URLs for update (and for repair)
Or this is about the .appinstaller file separate from a .msix used to install the .msix and used again later for updates? Then the phrasing is a bit confusing. Well, I guess the phrasing is a bit confusing either way :P
| >The following settings require the 2021 schema version in your `.appinstaller` file and Windows 10, version 2004 (build 19041) or later. | ||
|
|
||
| These settings enable repair of the Windows app when it has become tampered with. The source installer used to repair the app can be configured using the `<RepairURIs>` property. The Windows app will attempt to repair itself based on the App Installer URI; if inaccessible, it will use the Repair URIs to identify a repair source. A maximum of 10 Repair URIs can be configured for any Windows app. | ||
| These settings enable repair of the Windows app when it has become tampered with. The source installer used to repair the app can be configured using the `<RepairUris>` property. The Windows app will attempt to repair itself based on the App Installer URI; if inaccessible, it will use the Repair URIs to identify a repair source. A maximum of 10 Repair URIs can be configured for any Windows app. |
There was a problem hiding this comment.
"of the Windows app"
No. They enable repair of the MSIX package
Over focus on 'app' doesn't help. We need to fix the docs to be less 'app' focused and more 'package' focused.
Same comment applies throughout
Addresses reviewer comments: rewords the Automatic updates paragraph so the App Installer file reuse and UpdateUris fallback are clear, and shifts the auto-update/auto-repair prose from 'Windows app' to 'MSIX package' terminology per reviewer feedback that these settings act on the package. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 3f91f4ac-92c5-4012-bacf-5f63908b8716
|
Learn Build status updates of commit dd5ab5a: ✅ Validation status: passed
For more details, please refer to the build report. |
Resolves the documentation defects for the App Installer auto-update/repair elements (
UpdateUris/UpdateUri/RepairUris/RepairUri).What & why
The bug asked for element reference documentation for
UpdateURIs/UpdateURI/RepairURIs/RepairURI. The formal schema reference pages now exist in the schema docset (/uwp/schemas/appinstallerschema/element-s4-updateurisand siblings, maintained in the winrt-related repo). Within msix-docs the actionable gaps were correctness defects in the conceptual App Installer pages for these exact elements:UpdateURIs/UpdateURI/RepairURIs/RepairURIcorrected to the canonicalUpdateUris/UpdateUri/RepairUris/RepairUri. XML is case-sensitive, and the authoritative 2021 schema uses "Uris"/"Uri".2017/2namespace but used 2021-onlyUpdateURIs/RepairURIselements, in the wrong order. Switched it to the2021namespace and orderedUpdateSettingsbeforeUpdateUris/RepairUris(consistent with Steps 6–8).UpdateURI(an update element with an update description) instead ofRepairUri. Corrected the element and its description.s4:UpdateUris/s4:UpdateUri/s4:RepairUris/s4:RepairUrischema reference pages.Files
msix-src/app-installer/auto-update-and-repair--overview.mdmsix-src/app-installer/how-to-create-appinstaller-file.mdResolves AB#37966117