view CONTRIBUTING @ 43623:94eac340d212

packaging: stage files and dynamically generate WiX installer

Like we did for Inno, we want to make the WiX installer
"dumb" and simply consume source files from a directory
tree rather than have to define every single file in
installer files. This will greatly decrease the amount of
effort required to maintain the WiX installer since we don't
have to think that much about keeping files in sync.

This commit changes the WiX packager to populate a staging
directory as part of packaging. After it does so, it scans
that directory and dynamically generates WiX XML defining the
content within.

The IDs and GUIDs being generated are deterministic. So,
upgrades should work as expected in Windows Installer land.
(WiX has a "heat" tool that can generate XML by walking the
filesystem but it doesn't have this deterministic property,
sadly.)

As part of this change, GUIDs are now effectively reset.
So the next upgrade should be a complete wipe and replace.
This could potentially cause issues. But in my local testing,
I was able to upgrade an existing 5.1.2 install without
issue.

Compared to the previous commit, the installed files differ
in the following:

* A ReleaseNotes.txt file is now included
* A hgrc.d/editor.rc file is now generated (mercurial.rc has been
  updated to reflect this logical change to the content source)
* All files are marked as read-only. Previously, only a subset
  of files were. This should help prevent unwanted tampering.
  Although we may want to consider use cases like modifying
  template files...

This change also means that Inno and WiX are now using very
similar code for managing the install layout. This means
that on disk both packages are nearly identical. The
differences in install layout are as follows:

* Inno has a Copying.txt vs a COPYING.rtf for WiX.
  (The WiX installer wants to use RTF.)
* Inno has a Mercurial.url file that is an internet shortcut
  to www.mercurial-scm.org. (This could potentially be
  removed.)
* Inno includes msvc[mpr]90.dll files and WiX does not.
  (WiX installs the MSVC runtime via merge modules.)
* Inno includes unins000.{dat,exe} files. (WiX's state is
  managed by Windows Installer, which places things elsewhere.)

Because file lists are dynamically generated now, the test
ensuring things remain in sync has been deleted. Good riddance.

While this is a huge step towards unifying the Windows installers,
there's still some improvements that can be made. But I think
it is worth celebrating the milestone of getting both Inno
and WiX to essentially share core packaging code and workflows.
That should make it much easier to change the installers going
forward. This will aid support of Python 3.

Differential Revision: https://phab.mercurial-scm.org/D7173

Our full contribution guidelines are in our wiki, please see:

https://www.mercurial-scm.org/wiki/ContributingChanges

If you just want a checklist to follow, you can go straight to

https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist

If you can't run the entire testsuite for some reason (it can be
difficult on Windows), please at least run `contrib/check-code.py` on
any files you've modified and run `python contrib/check-commit` on any
commits you've made (for example, `python contrib/check-commit
273ce12ad8f1` will report some style violations on a very old commit).