Patchwork D7173: packaging: stage files and dynamically generate WiX installer

Oct. 24, 2019, 1:56 a.m.

indygreg created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

REVISION SUMMARY
  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 propertly, 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)
  - An hg.exe.local file is now created (this enabled dynamic link library redirection, which is desired)
  - 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.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D7173

AFFECTED FILES
  contrib/packaging/hgpackaging/py2exe.py
  contrib/packaging/hgpackaging/wix.py
  contrib/packaging/wix/contrib.wxs
  contrib/packaging/wix/dist.wxs
  contrib/packaging/wix/doc.wxs
  contrib/packaging/wix/guids.wxi
  contrib/packaging/wix/help.wxs
  contrib/packaging/wix/locale.wxs
  contrib/packaging/wix/mercurial.wxs
  contrib/packaging/wix/templates.wxs
  contrib/win32/mercurial.ini
  tests/test-install.t

CHANGE DETAILS

To: indygreg, #hg-reviewers
Cc: mercurial-devel

Submitter	phabricator
Date	Oct. 24, 2019, 1:56 a.m.
Message ID	<differential-rev-PHID-DREV-3a6nozumyzw6wj4owqg4-req@mercurial-scm.org>
Download	mbox \| patch
Permalink	/patch/42563/
State	Superseded
Headers	show Return-Path: <mercurial-devel-bounces@mercurial-scm.org> X-Original-To: patchwork@mercurial-scm.org Delivered-To: patchwork@mercurial-scm.org Received: from localhost (localhost [127.0.0.1]) by mercurial-scm.org (Postfix) with ESMTP id A0EC32C496; Wed, 23 Oct 2019 23:22:00 -0400 (EDT) X-Virus-Scanned: Debian amavisd-new at mercurial-scm.org Received: from mercurial-scm.org ([127.0.0.1]) by localhost (mercurial-scm.org [127.0.0.1]) (amavisd-new, port 10024) with LMTP id ysqhJSs1TF21; Wed, 23 Oct 2019 23:20:44 -0400 (EDT) Received: from mercurial-scm.org (localhost [IPv6:::1]) by mercurial-scm.org (Postfix) with ESMTP id EBE482C549; Wed, 23 Oct 2019 21:56:50 -0400 (EDT) X-Original-To: mercurial-devel@mercurial-scm.org Delivered-To: mercurial-devel@mercurial-scm.org Received: by mercurial-scm.org (Postfix, from userid 0) id 598382C54B; Wed, 23 Oct 2019 21:56:50 -0400 (EDT) Date: Thu, 24 Oct 2019 01:56:50 +0000 To: Phabricator <phabricator@mercurial-scm.org> From: "indygreg (Gregory Szorc)" <phabricator@mercurial-scm.org> Subject: D7173: packaging: stage files and dynamically generate WiX installer Message-ID: <differential-rev-PHID-DREV-3a6nozumyzw6wj4owqg4-req@mercurial-scm.org> X-Priority: 3 X-Phabricator-Sent-This-Message: Yes X-Mail-Transport-Agent: MetaMTA X-Auto-Response-Suppress: All X-Phabricator-Mail-Tags: <differential-other>, <differential-review-request>, <differential-cc>, <differential-reviewers> X-Herald-Rules: <1> X-Phabricator-To: <PHID-USER-p54bpwbifxx7sbgpx47d> X-Phabricator-To: <PHID-PROJ-3dvcxzznrjru2xmmses3> X-Phabricator-Cc: <PHID-USER-q42dn7cc3donqriafhjx> Precedence: bulk Thread-Topic: PHID-DREV-3a6nozumyzw6wj4owqg4 X-Phabricator-Mail-ID: 308115 X-Phabricator-Send-Attempt: aiuxcunt4jmqsy45 Thread-Index: MTQ4NGJjNWJjYWY3OTI1NGI3OTk1OGZhNWJl X-Phabricator-Stamps: actor(@indygreg) application(Differential) author(@indygreg) blocking-reviewer(#hg-reviewers) herald(H1) monogram(D7173) new() object-type(DREV) phid(PHID-DREV-3a6nozumyzw6wj4owqg4) reviewer(#hg-reviewers) revision-repository(rHG) revision-status(needs-review) subscriber(@mercurial-devel) via(conduit) MIME-Version: 1.0 Cc: mercurial-devel@mercurial-scm.org X-BeenThere: mercurial-devel@mercurial-scm.org X-Mailman-Version: 2.1.18 List-Id: <mercurial-devel.mercurial-scm.org> List-Unsubscribe: <https://www.mercurial-scm.org/mailman/options/mercurial-devel>, <mailto:mercurial-devel-request@mercurial-scm.org?subject=unsubscribe> List-Archive: <http://www.mercurial-scm.org/pipermail/mercurial-devel/> List-Post: <mailto:mercurial-devel@mercurial-scm.org> List-Help: <mailto:mercurial-devel-request@mercurial-scm.org?subject=help> List-Subscribe: <https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel>, <mailto:mercurial-devel-request@mercurial-scm.org?subject=subscribe> Reply-To: "indygreg \(Gregory Szorc\)" <phabricator+D7173+public+24ed0df0d187b9ff@mercurial-scm.org> Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Errors-To: mercurial-devel-bounces@mercurial-scm.org Sender: "Mercurial-devel" <mercurial-devel-bounces@mercurial-scm.org>

Patchwork D7173: packaging: stage files and dynamically generate WiX installer

Comments

Patch