fix: the MSI package can add the mrdocs bin/ directory to the PATH - #1324
Open
gennaroprota wants to merge 2 commits into
Conversation
This fixes a bug for which installing MrDocs from a newer MSI did not replace the MrDocs already installed, because CPack gave every MSI a new upgrade code, so Windows saw each as an unrelated product. CI's logs warn about it: "CPACK_WIX_UPGRADE_GUID implicitly set". With a fixed upgrade code, the major upgrade that CPack's MSI template declares finds the previous install and removes it.
Contributor
🧾 Changes by Scope
🔝 Top Files
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1324 +/- ##
========================================
Coverage 83.12% 83.12%
========================================
Files 35 35
Lines 3662 3662
Branches 844 844
========================================
Hits 3044 3044
Misses 410 410
Partials 208 208
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
The MSI now asks, with a checkbox checked by default, whether to add the mrdocs installation directory to the system PATH, and uninstalling MrDocs removes it again. Only a per-machine install may change the system PATH, so the MSI now declares that scope (it declared no scope before). Fixes cppalliance#1018.
gennaroprota
force-pushed
the
fix/the_msi_package_can_add_the_mrdocs_installation_directory_to_the_path
branch
from
September 25, 2026 15:50
357d7f8 to
ec8f18a
Compare
|
An automated preview of the documentation is available at https://1324.mrdocs.prtest2.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-09-25 16:02:22 UTC |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Installing MrDocs from the MSI didn't add mrdocs to the PATH, so it couldn't be run by name. This PR makes the MSI offer to add it. It also fixes a related problem: each MSI had a new upgrade code, so a newer MSI didn't replace the install already there. This means that entries for both old and new installations would be added to PATH.
Changes
REMOVE=AddToPath.Testing
Built the MSI locally with CPack and WiX 3.14, and checked its tables:
WiX's validation passes, with only the ICE61 warning, which comes from CPack's own MSI template. CI builds the MSI on every Windows build.
Documentation
The Windows tip on the Install page says that the MSI adds
bin\to the PATH, and how to add it later.Closes #1018.