Cylc-flow: conf: ensure all proposed changes have been enacted

[oliver-sanders]

Ensure all changed document in the config change proposal document have been implemented pre 8.0.0 release.

Pull requests welcome!

[wxtim]

Copied from https://cylc.github.io/cylc-admin/proposal-config-changes.html#agreed-global-config-changes

Global Config Checklist

These don't need upgraders for Cylc 8.

• [x] [authentication] -> obsolete (#3845)
• [x] [cylc][events]mail * -> [scheduler][mail] (#3846)
• [x] [cylc][events] -> [scheduler][events] (@wxtim #3907)
• [x] [cylc]task event mail interval -> [scheduler][mail]task event batch interval (#3846)
• [x] [cylc]health check interval -> [scheduler]health check interval obsolete (#3492)
• [x] process pool * -> [scheduler]process pool * (#3943)
• [x] [documentation] -> obsolete (#3911)
• [x] [document viewers] -> obsolete (#3911)
• [x] [suite logging] -> [scheduler][logging] (#3943)
• [x] run directory rolling archive length -> [scheduler]run directory rolling archive length (#3943)
• [x] [task events]mail smtp -> obsolete (#3914)
• [x] [task events]mail retry delays -> obsolete (#3914)
• [x] [suite servers]auto restart delay -> [scheduler]auto restart delay (@wxtim #3962)
• [x] [suite servers]run hosts -> [scheduler][run hosts]available (@wxtim #3962)
• [x] [suite servers]condemned hosts -> [scheduler][run hosts]condemned (@wxtim #3962)
• [x] [suite servers]run ports -> [scheduler][run hosts]ports (@wxtim #3962)
• [x] [suite servers]ranking -> [scheduler][run hosts]ranking (@wxtim #3962)
• [x] [suite host self-identification] -> [scheduler][host self-identification] (@wxtim #3962)
• [x] [job platforms] -> [platforms] (#3626)
• [x] [job platforms][]task communication method -> [platforms][]communication method (#3626)
• [x] [cylc]UTC mode -> [scheduler]UTC mode (@wxtim #3907)
• [x] [editors] - discussed at CylcCon. Agreed to keep these settings but discourage their use. Also, change them to use to $EDITOR & $GEDITOR if set (otherwise use current defaults).
• [x] disable interactive command prompts -> obsolete (#3774)
• [x] [test battery] -> obsolete (https://github.com/cylc/cylc-flow/pull/3808/commits/7d928e123e9b0db711f9c9e2af8d57baefb926ae)
• [x] [job platforms][]batch system -> [platforms][]job runner (#3992)
• [x] [job platforms][]batch submit command template -> [platforms][]job runner command template (#3992)
• [x] [job platforms][]task event handler retry delays -> obsolete (#3908)
• [x] [job platforms][]scp command -> obsolete (#3908)
• [x] Remove the cylc [util] scp-transfer command. (#3634)

Suite Config Checklist

Don't forget to add upgraders

• [x] [cylc]force run mode & required run mode -> obsolete (#3844)
• [x] [visualization] -> obsolete (Covered separately by #3379, Hopefully closed by #4273)
• [x] [cylc][authentication] -> obsolete (#3845)
• [x] [cylc]disable automatic shutdown -> obsolete (#3942)
• [x] [cylc][parameters] -> [task parameters] (@wxtim #3963 )
• [x] [cylc][parameter templates] -> [task parameters][templates] (@wxtim #3963 )
• [x] [scheduling]hold after point -> [scheduling]hold after cycle point (#3947)
• [x] [scheduling]stop after cycle point <- new (#3883)
• [x] [scheduling][special tasks]exclude at start-up & include at start-up -> obsolete (@wxtim #3967 )
• [x] [runtime][][job] -> [runtime][] (This applies only to the settings which have not been deprecated by the platforms work: execution polling intervals, execution retry delays, execution time limit, submission polling intervals & submission retry delays. See discussion and #3480.) Upgrade code in master and commented atm. (#3968, #4075)
• [x] [runtime][][remote]suite definition directory -> obsolete (Note that we also need to deprecate the environment variables $CYLC_SUITE_DEF_PATH & $CYLC_SUITE_DEF_PATH_ON_SUITE_HOST.) (#4126)
• [x] [cylc][events]mail * -> [scheduler][mail] (#3846)
• [x] [cylc][events]mail smtp -> obsolete (#3914)
• [x] [cylc][events] -> [scheduler][events] (@wxtim #3907)
• [x] [cylc]task event mail interval -> [scheduler][mail]task event batch interval (#3846)
• [x] [runtime][][events]mail smtp -> obsolete (#3914)
• [x] [runtime][][events]mail retry delays -> obsolete (#3846)
• [x] [cylc][reference test]expected task failures -> [scheduler][events]expected task failures (#3957)
• [x] [scheduler][events]abort if any task fails -> obsolete (#3785)
• [x] [cylc][environment] -> obsolete (#3947)
• [x] [cylc]health check interval -> [scheduler]health check interval obsolete (#3492)
• [x] [cylc] time settings -> [scheduler] (This covers UTC mode, cycle point format, cycle point num expanded year digits and cycle point time zone (discussed at CylcCon)). (@wxtim #3907)
• [x] [cylc][simulation]disable suite event handlers -> obsolete (Agreed at CylcCon to move this and make it positive. However, now proposing to remove it and automatically disable event handlers in simulation and dummy modes. It’s easy to test event handlers, if you need to, in a real test suite written for that purpose and there’s no obvious use case for this when running a real suite in simulation or dummy mode.) (#3972)
• [x] [runtime][]extra log files -> obsolete (@wxtim #3969)

Other tasks

• [x] Create a change guide in cylc/doc - Pass to issue https://github.com/cylc/cylc-doc/issues/170
• [x] Final sanity check that everything matches in the cylc/admin doc because the checklist was created by a massive crude copy and paste. @dpmatthews
• [x] Review documentation embedded in config.

[MetRonnie]

Might be a good idea to add our names next to items in the checklist when we start working on them, to avoid two people doing the same one

[hjoliver]

:confounded: sorry @wxtim that was definitely accidental.

[MetRonnie]

[cylc]health check interval -> [scheduler]health check interval

This seems to be entirely missing from global config. Anyone know what happened to it? Ah, I see it was changed in #3492: [cylc]health check interval -> [cylc][main loop][health check]interval

[oliver-sanders]

Ah yeah #3492 made health check a configurable plugin, good to leave it as [scheduler][main loop][health check]interval.

[wxtim]

So I think that's everything which isn't blocked!

[MetRonnie]

Oops, I still need to do #3910

[hjoliver]

So I think that's everything which isn't blocked!

Wow that was a load of PRs, well done :bouquet:

[wxtim]

• [x] Create change guide in docs - pass to issue https://github.com/cylc/cylc-doc/issues/170

[oliver-sanders]

https://github.com/cylc/cylc-flow/issues/4034

[MetRonnie]

I've unticked

[editors] - discussed at CylcCon. Agreed to keep these settings but discourage their use. Also, change them to use to $EDITOR & $GEDITOR if set (otherwise use current defaults).

because we haven't discouraged their use or set them to use $EDITOR or $GEDITOR by default.

Also

[visualization] -> obsolete

because we haven't done it yet, even if it's covered by another issue

[oliver-sanders]

because we haven't discouraged their use or set them to use $EDITOR or $GEDITOR by default.

Was done by https://github.com/cylc/cylc-flow/pull/3692

[MetRonnie]

Ah ok, is the "if unspecified Cylc will use $(G)EDITOR" spiel enough to consider their use discouraged?

[oliver-sanders]

I think the "discourage use" was more aimed at the [editors] section i.e. stop calling out to text editors from code, not sure.

[oliver-sanders]

for