( )⚙ D9982 hooks: add a `auto` value for `hooks.*run-with-plain`

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9982

hooks: add a `auto` value for `hooks.*run-with-plain`
ClosedPublic

Authored by marmoute on Feb 10 2021, 6:47 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHGb910be772eb9: hooks: add a `auto` value for `hooks.*run-with-plain`
rHG8872e75ee9f4: hooks: add a `auto` value for `hooks.*run-with-plain`
Summary

That setting restore the behavior pre-5.6. The current HGPLAIN value is simply
passed to the hooks.

This allow user who needs it to fully mitigate the behavior change introduced
in Mercurial 5.7 by restoring the older behavior.

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.

Event Timeline

marmoute created this revision.Feb 10 2021, 6:47 PM
baymax updated this revision to Diff 25544.Feb 10 2021, 8:11 PM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 25546.Feb 11 2021, 5:25 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

durin42 accepted this revision.Feb 11 2021, 11:08 AM
durin42 added a subscriber: durin42.

I'm not happy about this footgun option, but see why we need it.

This revision is now accepted and ready to land.Feb 11 2021, 11:08 AM
marmoute added a commit: rHG8872e75ee9f4: hooks: add a `auto` value for `hooks.*run-with-plain`.Feb 11 2021, 11:34 AM
Closed by commit rHG8872e75ee9f4: hooks: add a `auto` value for `hooks.*run-with-plain` (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/helptext/config.txt (2 lines)
Mmercurial/hook.py (5 lines)
Mtests/test-hook.t (4 lines)

Diff 25552

mercurial/helptext/config.txt

incoming.autobuild = /my/build/hook incoming.autobuild = /my/build/hook
# force autobuild hook to run before other incoming hooks # force autobuild hook to run before other incoming hooks
priority.incoming.autobuild = 1 priority.incoming.autobuild = 1
### control HGPLAIN setting when running autobuild hook ### control HGPLAIN setting when running autobuild hook
# HGPLAIN always set (default from Mercurial 5.7) # HGPLAIN always set (default from Mercurial 5.7)
incoming.autobuild:run-with-plain = yes incoming.autobuild:run-with-plain = yes
# HGPLAIN never set # HGPLAIN never set
incoming.autobuild:run-with-plain = no incoming.autobuild:run-with-plain = no
# HGPLAIN inherited from environment (default before Mercurila 5.7)
incoming.autobuild:run-with-plain = auto
Most hooks are run with environment variables set that give useful Most hooks are run with environment variables set that give useful
additional information. For each hook below, the environment variables additional information. For each hook below, the environment variables
it is passed are listed with names in the form ``$HG_foo``. The it is passed are listed with names in the form ``$HG_foo``. The
``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks. ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
They contain the type of hook which triggered the run and the full name They contain the type of hook which triggered the run and the full name
of the hook in the config, respectively. In the example above, this will of the hook in the config, respectively. In the example above, this will
be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``. be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.

mercurial/hook.py

if repo is not None: if repo is not None:
tr = repo.currenttransaction() tr = repo.currenttransaction()
repo.dirstate.write(tr) repo.dirstate.write(tr)
if tr and tr.writepending(): if tr and tr.writepending():
env[b'HG_PENDING'] = repo.root env[b'HG_PENDING'] = repo.root
env[b'HG_HOOKTYPE'] = htype env[b'HG_HOOKTYPE'] = htype
env[b'HG_HOOKNAME'] = name env[b'HG_HOOKNAME'] = name
if ui.config(b'hooks', b'%s:run-with-plain' % name) == b'auto':
plain = ui.plain()
else:
plain = ui.configbool(b'hooks', b'%s:run-with-plain' % name) plain = ui.configbool(b'hooks', b'%s:run-with-plain' % name)
if plain: if plain:
env[b'HGPLAIN'] = b'1' env[b'HGPLAIN'] = b'1'
else: else:
env[b'HGPLAIN'] = b'' env[b'HGPLAIN'] = b''
for k, v in pycompat.iteritems(args): for k, v in pycompat.iteritems(args):
# transaction changes can accumulate MBs of data, so skip it # transaction changes can accumulate MBs of data, so skip it
# for external hooks # for external hooks

tests/test-hook.t

$ cat << EOF >> .hg/hgrc $ cat << EOF >> .hg/hgrc
> [hooks] > [hooks]
> pre-version.testing-default=echo '### default ###' plain: \${HGPLAIN:-'<unset>'} > pre-version.testing-default=echo '### default ###' plain: \${HGPLAIN:-'<unset>'}
> pre-version.testing-yes=echo '### yes #######' plain: \${HGPLAIN:-'<unset>'} > pre-version.testing-yes=echo '### yes #######' plain: \${HGPLAIN:-'<unset>'}
> pre-version.testing-yes:run-with-plain=yes > pre-version.testing-yes:run-with-plain=yes
> pre-version.testing-no=echo '### no ########' plain: \${HGPLAIN:-'<unset>'} > pre-version.testing-no=echo '### no ########' plain: \${HGPLAIN:-'<unset>'}
> pre-version.testing-no:run-with-plain=no > pre-version.testing-no:run-with-plain=no
> pre-version.testing-auto=echo '### auto ######' plain: \${HGPLAIN:-'<unset>'}
> pre-version.testing-auto:run-with-plain=auto
> EOF > EOF
$ (unset HGPLAIN; hg version --quiet) $ (unset HGPLAIN; hg version --quiet)
### default ### plain: 1 ### default ### plain: 1
### yes ####### plain: 1 ### yes ####### plain: 1
### no ######## plain: <unset> ### no ######## plain: <unset>
### auto ###### plain: <unset>
Mercurial Distributed SCM (*) (glob) Mercurial Distributed SCM (*) (glob)
$ HGPLAIN=1 hg version --quiet $ HGPLAIN=1 hg version --quiet
### default ### plain: 1 ### default ### plain: 1
### yes ####### plain: 1 ### yes ####### plain: 1
### no ######## plain: <unset> ### no ######## plain: <unset>
### auto ###### plain: 1
Mercurial Distributed SCM (*) (glob) Mercurial Distributed SCM (*) (glob)