This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8476

packaging: move version derivation to run_wix_packaging()
ClosedPublic

Authored by indygreg on Apr 21 2020, 10:39 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGa5740490eb5f: packaging: move version derivation to run_wix_packaging()
rHGcfc66b804b1a: packaging: move version derivation to run_wix_packaging()
Summary

With the previous commit moving signing inline, we no
longer need to compute the version string in build_installer()
and can instead move this logic to run_wix_packaging(). This
makes the logic in build_installer() simpler, which makes it
easier to implement alternate building mechanisms.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Revision Contents
Changeset List

PathPackages
Mcontrib/packaging/hgpackaging/wix.py (15 lines)

Diff 21244

contrib/packaging/hgpackaging/wix.py

hg_build_dir, hg_build_dir,
python_exe, python_exe,
'wix', 'wix',
requirements_txt, requirements_txt,
extra_packages=EXTRA_PACKAGES, extra_packages=EXTRA_PACKAGES,
extra_packages_script=extra_packages_script, extra_packages_script=extra_packages_script,
) )
orig_version = version or find_version(source_dir)
version = normalize_windows_version(orig_version)
print('using version string: %s' % version)
if version != orig_version:
print('(normalized from: %s)' % orig_version)
build_dir = hg_build_dir / ('wix-%s' % arch) build_dir = hg_build_dir / ('wix-%s' % arch)
staging_dir = build_dir / 'stage' staging_dir = build_dir / 'stage'
build_dir.mkdir(exist_ok=True) build_dir.mkdir(exist_ok=True)
# Purge the staging directory for every build so packaging is pristine. # Purge the staging directory for every build so packaging is pristine.
if staging_dir.exists(): if staging_dir.exists():
print('purging %s' % staging_dir) print('purging %s' % staging_dir)
p.unlink() p.unlink()
return run_wix_packaging( return run_wix_packaging(
source_dir, source_dir,
build_dir, build_dir,
staging_dir, staging_dir,
arch, arch,
version=version, version=version,
orig_version=orig_version,
msi_name=msi_name, msi_name=msi_name,
extra_wxs=extra_wxs, extra_wxs=extra_wxs,
extra_features=extra_features, extra_features=extra_features,
signing_info=signing_info, signing_info=signing_info,
) )
def run_wix_packaging( def run_wix_packaging(
source_dir: pathlib.Path, source_dir: pathlib.Path,
build_dir: pathlib.Path, build_dir: pathlib.Path,
staging_dir: pathlib.Path, staging_dir: pathlib.Path,
arch: str, arch: str,
version: str, version: str,
orig_version: str,
msi_name: typing.Optional[str] = "mercurial", msi_name: typing.Optional[str] = "mercurial",
extra_wxs: typing.Optional[typing.Dict[str, str]] = None, extra_wxs: typing.Optional[typing.Dict[str, str]] = None,
extra_features: typing.Optional[typing.List[str]] = None, extra_features: typing.Optional[typing.List[str]] = None,
signing_info: typing.Optional[typing.Dict[str, str]] = None, signing_info: typing.Optional[typing.Dict[str, str]] = None,
): ):
"""Invokes WiX to package up a built Mercurial. """Invokes WiX to package up a built Mercurial.
``signing_info`` is a dict defining properties to facilitate signing the ``signing_info`` is a dict defining properties to facilitate signing the
installer. Recognized keys include ``name``, ``subject_name``, installer. Recognized keys include ``name``, ``subject_name``,
``cert_path``, ``cert_password``, and ``timestamp_url``. If populated, ``cert_path``, ``cert_password``, and ``timestamp_url``. If populated,
we will sign both the hg.exe and the .msi using the signing credentials we will sign both the hg.exe and the .msi using the signing credentials
specified. specified.
""" """
orig_version = version or find_version(source_dir)
version = normalize_windows_version(orig_version)
print('using version string: %s' % version)
if version != orig_version:
print('(normalized from: %s)' % orig_version)
if signing_info: if signing_info:
sign_with_signtool( sign_with_signtool(
staging_dir / "hg.exe", staging_dir / "hg.exe",
"%s %s" % (signing_info["name"], version), "%s %s" % (signing_info["name"], version),
subject_name=signing_info["subject_name"], subject_name=signing_info["subject_name"],
cert_path=signing_info["cert_path"], cert_path=signing_info["cert_path"],
cert_password=signing_info["cert_password"], cert_password=signing_info["cert_password"],
timestamp_url=signing_info["timestamp_url"], timestamp_url=signing_info["timestamp_url"],