Skip to content

Latest commit

 

History

History
844 lines (575 loc) · 33.7 KB

CHANGES.md

File metadata and controls

844 lines (575 loc) · 33.7 KB

Selected Cylc Changes

For the full list of all changes for each release see closed milestones.


cylc-7.5.0 (2017-08-29)

Enhancements

#2387, #2330: New suite.rc [meta] sections for suite and task metadata. These hold the existing title, description, and URL items, plus arbitrary user-defined items. Metadata items can be passed to event handlers (e.g. a site-specific task "priority" or "importance" rating could inform an event-handler's decision on whether or not to escalate task failures).

#2298, #2401: New shell function cylc__job_abort <message> to abort task job scripts with a custom message that can be passed to task failed event handlers.

#2204: Remove auto-fallback to HTTP communications, if HTTPS is not available. Now HTTP is only used if explicitly configured.

#2332, #2325, #2321, #2312: Validation efficiency improvements.

#2291, #2303, #2322: Runtime efficiency improvements.

#2286: New command cylc report-timings to generate reports of task runtime statistics.

#2304: New event handlers for general CRITICAL events.

#2244, #2258: Advanced syntax for excluding multiple points from cycling sequences.

#2407: Documented exactly how Cylc uses ssh, scp, and rsync to interact with remote job hosts.

#2346, #2386: cylc graph now plots implicit dependences as grayed-out ghost nodes.

#2343: Improved the "Running Suites" section of the User Guide, including documentation of suite remote control.

#2344: Attempt to access suite service files via the filesystem first, before ssh, for other accounts on the suite host.

#2360: Better validation of suite parameter configuration.

#2314: In debug mode, send bash job script xtrace output (from set -x) to a separate log file.

Fixes

#2409: Fixed the cylc spawn command (it was killing tasks, since cylc-7).

#2378: Fixed use of negative offsets by the cylc suite-state command.

#2364: Correctly load completed custom task outputs on restart.

#2350: Handle bad event handler command line templates gracefully.

#2308: The parameterized task environment variable $CYLC_TASK_PARAM_<param> is now guaranteed to be defined before any use of it in the user-defined task environment section.

#2296: Prevent suites stalling after a restart that closely follows a warm-start (now the restart, like the warm start, ignores dependence on tasks from before the warm start point).

#2295: Fixed cylc cat-log "open in editor" functionality for remote job logs.

#2412: Fixed duplication of log messages to the old log after restart.


cylc-7.4.0 (2017-05-16)

Enhancements and fixes.

Highlighted Changes

#2260: Open job logs in your text editor, from CLI (cylc cat-log) or GUI.

#2259: cylc gscan - various improvements: right-click menu is now for suite operations only; other items moved to a main menubar and toolbar (which can be hidden to retain gscan's popular minimalist look); added all suite stop options (was just the default clean stop); task-state colour-key popup updates in-place if theme changed; new collapse/expand-all toobar buttons.

#2275: Pass suite and task URLs to event handlers.

#2272: Efficiency - reduce memory footprint.

#2157:

  • internal efficiency improvements
  • allow reset of individual message outputs
  • "cylc submit" can now submit families

#2244: Graph cycling configuration: multiple exclusion points.

#2240: Stepped integer parameters.

Fixes

#2269: Fix auto suite-polling tasks (i.e. inter-suite dependence graph syntax) - Broken in 7.3.0.

#2282: Fix global config processing of boolean settings - users could not override a site True setting to False.

#2279: Bundle Jinja2 2.9.6. (up from 2.8) - fixes a known issue with Jinja2 "import with context".

#2255: Fix handling of suite script items that contain nothing but comments.

#2247: Allow cylc graph --help in the absence of an X environment.

Other Changes

#2270: Detect and fail null tasks in graph.

#2257: cylc gscan - graceful exit via Ctrl-C.

#2252: ssh: add -Y (X Forwarding) only if necessary.

#2245: SSL certficate: add serial number (issue number). This allows curl, browsers, etc. to connect to suite daemons.

#2265: cylc gpanel - restored sorting of items by suite name.

#2250: Updated installation docs for HTTPS-related requirements.


cylc-7.3.0 (2017-04-10)

New Suite Design Guide, plus other enhancements and fixes.

Highlighted Changes

#2211: New comprehensive Suite Design Guide document to replace the outdated Suite Design section in the User Guide.

#2232: cylc gscan GUI: stop, hold, and release suites or groups of suites.

#2220: dummy and simulation mode improvements:

  • new dummy-local mode runs dummy tasks as local background jobs (allows dummy running other-site suites).
  • proportional run length, if tasks configure an execution time limit
  • single common [simulation] configuration section for dummy, dummy-local, and simulation modes.
  • dummy or simulated tasks can be made to fail at specific cycle points, and for first-try only, or all tries.
  • custom message outputs now work in simulation mode as well as the dummy modes.

#2218: fix error trapping in job scripts (degraded since job file refactoring in 7.1.1)

#2215: SGE batch system support - fixed formatting of directives with a space in the name.

Other Notable Changes

#2233: Upgraded the built-in example suites to cylc-7 syntax.

#2221: cylc gui GUI dot view - maintain user selection during update.

#2217: cylc gscan GUI - fix tracebacks emitted during suite initialization.

#2219: add user@host option to cylc monitor an cylc gui. Allows suite selection at startup using cylc scan output.

#2222: cylc gui GUI graph view - fixed right-click "view prerequisites" sub-menu.

#2213: Record family inheritance structure in the run database.


cylc-7.2.1 (2017-03-23)

Minor enhancements and fixes.

Highlighted Changes

#2209: Fixed the cylc gui graph view, broken at cylc-7.2.0.

#2193: Restored cylc gscan suite-stopped status checkerboard icons, lost at cylc-7.1.1.

#2208: Use suite host name instead of suite name in the SSL certificate "common name".

#2206: Updated User Guide installation section.

Other Notable Changes

#2191: Clearer task prerequisites print-out.

#2197: Removed the bundled external OrderedDict package.

#2194: cylc gscan - better handling of suites that are still initializing.


cylc-7.2.0 (2017-03-06)

Minor enhancements and fixes (note mid-level version number bumped up to reflect significant changes included in 7.1.1 - esp. job file refactoring).

Highlighted Changes

#2189: New assert and raise functions for handling Jinja2 errors in suites.

Other Changes

#2186: Use lowercase local shell variable names in new job script shell functions introduced in 7.1.1, to avoid overriding shell built-ins such as $HOSTNAME.

#2187: Fixed a bug causing restart failure in the presence of an active broadcast of a submission timeout value.

#2183: Use site-configured suite host self-identification, if present, as hostname in the SSL certificate.

#2182: Fixed failed User Guide build in 7.1.1.


cylc-7.1.1 (2017-02-27)

Minor enhancements and fixes (plus a significant change: task job file refactoring).

Highlighted Changes

#2141: Tidier task job files: hide error trap and messaging code, etc., in external shell functions.

#2134: Suite-state polling (e.g. for inter-suite triggering) now automatically detects and uses the remote suite cycle point format.

#2128: Suite-state polling (e.g. for inter-suite triggering) now works with custom task messages.

#2172: Added a built-in Jinja2 filter for formatting ISO8601 date-time strings.

#2164: Fixed support for Jinja2 in site/user config files, broken at 6.11.0.

#2153: cylc gui - use task execution time limit as the default mean elapsed time, to compute a progress bar for the first instance of a cycling task.

#2154: cylc gui graph view - fixed right-click sub-menu activation, broken at 7.1.0.

#2158: cylc gui graph view: fix right-click family ungroup, broken since 7.0.0.

Other Changes

#2142: New "select all" and "select none" buttons in the cylc gui task filter dialog.

#2163: (Development) New automated profiling test framework for comparing performance between Cylc versions.

#2160: Better suite stall detection in the presence of clock-triggered tasks.

#2156: Fix potential division-by-zero error in cylc gscan.

#2149: Fix handling of cycle point offsets in weeks (e.g. "P1W").

#2146: Documented how to set multiple -l VALUE directives in jobs submitted to PBS.

#2129: Allow initial cycle point to be specified on the command line for all relevant commands, if not specified in the suite definition.

#2139: Fixed error in use of execution time limit in jobs submitted to Platform LSF.

#2176: cylc gui graph view - fixed a bug that could cause a blank graph view window, since 7.0.0.

#2161: gcylc gui- disallow insertion at cycle points that are not valid for the task (unless overridden with --no-check).


cylc-7.1.0 (2017-01-26)

Minor enhancements and fixes.

Highlighted Changes

#2021: New command cylc checkpoint to create a named suite state checkpoint that you can restart from.

#2124: open another GUI window (to view another suite) via the gcylc File menu.

#2100: group multiple task event notifications into a single email over a 5 minute interval (configurable).

#2112: broadcast settings can now be loaded (or cancelled) from a file as well as the command line.

#2096: the cylc gscan GUI can now display summary states for suites owned by others.

Other Changes

#2126: fixed occasional misidentification of suite stall when only succeeded tasks exist just prior to shutdown.

#2127: fixed the cylc diff command (broken at 7.0.0)

#2119: fixed remote job kill after a suite definition reload, for task proxies that exist at the time of the reload.

#2025: GUI right-click menu items can now be selected with either mouse button 1 or 3.

#2117: improved logic for adding lib/cylc to Python sys.path (there was one reported instance of the system-level cherrpy being imported instead of the Cylc-bundled one, in cylc-7.0.0).

#2114: documented syntax-driven line continuation in suite graph configuration.

#2116: corrected a rare edge-case side-effect of manual task-state reset.

#2107: cylc insert - disallow insertion at cycle points that are not valid for the task (unless overridden with --no-check).

#2106: fixed cylc get-config --python output formatting, broken since cylc-6.6.0.

#2097: fixed a problem with task host and owner task proxies reloaded at suite restart (could cause job poll and kill to fail in some cases, for tasks in this category).

#2095: fixed validation of mixed deprecated and new suite.rc syntax.

cylc-7.0.0 (2016-12-21)

cylc-7 client/server communications is not backward compatible with cylc-6.

Note that cylc-7 bug fixes were back-ported to a series of 6.11.x releases, for those who have not transitioned to cylc-7 yet.

Highlighted Changes

#1923: A new HTTPS communications layer, replaces Pyro-3 Object RPC for all client-server communications. Suite daemons are now web servers!

#2063: Removed deprecated cylc-5 syntax and features.

#2044: Suite start-up now aborts with a sensible message on suite configuration errors (previously this happened post daemonization so the user had to check suite logs to see the error).

#2067: Consolidated suite service files (passphrase, SSL files, contact file, etc.) under .service/ in the suite run directory; the suite registration database and port files under $HOME/.cylc/ are no longer used; suites can now be grouped in sub-directory trees under the top level run directory.

#2033: Allow restart from suite state checkpoints other than the latest (checkpoints are also recorded automatically before and after restarts, and on reload).

#2024: cylc gscan now supports collapsible suite groups via a top level suite config group item. Right-click View Column "Group".

#2074: Task retry states and timers, and poll timers, now persist across suite restarts. Waiting tasks are not put in the held state before shutdown. Held tasks are not automatically released on restart.

#2004: Task event handlers are now continued on restart.

Other Changes

#2042: Documented [scheduling]spawn to max active cycle points (new in 6.11.0), which lets successive instances of the same task run out of order if dependencies allow.

#2092: New command cylc get-suite-contact to print suite contact information (host, port, PID, etc.)

#2089: Improved documentation on cycling workflows and use of parameterized tasks as a proxy for cycling.

#2021: cylc gui: removed the "connection failed" warning dialog that popped up on suite shutdown. This should be obvious by the reconnection countdown timer in the info bar.

#2023: New custom event email footer via global or suite config.

#2013: Fixed "remove task after spawning" which since 6.9.0 would not force a waiting task to spawn its successor.

#2071: Fix quote stripping on initial cycle point = "now".

#2070: Fix dummy mode support for custom task outputs: they were incorrectly propagated to other tasks.

#2065: cylc gscan now supports suite name filtering via a --name command line option.

#2060: 5-second timeout if hanging connections are encountered during port scanning.

#2055: Task elapsed times now persist over restarts.

#2046: Multi-task interface for cylc show. Fixed View Prerequisites for tasks in the runahead pool.

#2049: Per-host job submission and execution polling intervals via global/user config files.

#2051: Bundle Jinja2 2.8 with Cylc - one less external software dependency.

#2088: Support dependence on absolute cycle points in cycling graphs.

cylc-6.11.4 (2017-01-26)

More bug fixes backported from early Cylc-7 releases.

#2120: fixed remote job kill after a +suite definition reload, for task proxies that exist at the time of the reload.

#2111: fixed member-expansion of complex (FAMILY:fail-any & FAMILYI:finish-all) graph triggers.

#2102: fixed validation of mixed deprecated and new suite.rc syntax.

#2098: fixed a problem with task host and owner task proxies reloaded at suite restart (could cause job poll and kill to fail in some cases, for tasks in this category).

cylc-6.11.3 (2016-12-21)

One minor bug fix on top of 6.11.2.

#2091: Since 6.11.0 use of cylc-5 special "cold start tasks" caused downstream tasks to become immortal. This fixes the problem, but note that you should no longer be using this deprecated feature (which will be removed from cylc-7).

cylc-6.11.2 (2016-10-19)

Some minor enhancements and fixes.

Highlighted Changes

#2034: Allow restart from checkpoints. These are currently created before and after reloads, and on restart. (Note that since 6.11.0 suite state dump files no longer exist).

#2047: Documented the new "[scheduling]spawn to max active cycle points" suite configuration item, which allows successive instances of the same task to run out of order if the opportunity arises.

#2048: Allow "view prerequisites" for tasks in the 'runahead' state.

#2025: Provide a configurable event mail footer (suite or site/user configuration).

#2032: cylc gui - removed the annoying warning dialog for connection failed. Take note of the connection countdown in the status bar instead.

Other Changes

#2016: Fixed a Python traceback occasionally generated by the gcylc GUI log view window.

#2018: Restored the incremental printing of dots to stdout from the cylc suite-state polling command (lost at 6.11.1).

#2014: Fixed "remove after spawning". Since 6.9.0 this would not force-spawn the successor of a waiting task.

#2031: cylc gscan - fixed occasional jumping status icons introduced in 6.11.1.

#2040: Corrected documentation for the cylc cat-log command (it was using the alias cylc log).

cylc-6.11.1 (2016-09-22)

Three minor bug fixes on top of 6.11.0:

#2002: fix a bug in the graph string parser - if a task appears both with and without a cycle point offset in the same conditional trigger expression (unlikely, but possible!)

#2007: fix handling of OS Error if the user run into the limit for number of forked processes.

#2008: fix occasional traceback from cylc gsan.

cylc-6.11.0 (2016-09-13)

Highlighted Changes

#1953: Parameterized tasks: generate tasks automatically without using messy Jinja2 loops.

#1929: Under [runtime]:

  • New task [[[job]]] sub-sections unify the various batch system, job execution, and job polling settings (older settings deprecated).
  • A new [[[job]]] execution time limit setting allows cylc to:
    • automatically generate batch system time limit directives;
    • run background or at jobs with the timeout command;
    • poll job with configurable delays (default 1, 3, 10 minutes) after reaching the time limit.
  • Moved the content of the old [event hooks] section to a unified [events] section (older settings deprecated).

#1884: cylc gscan displays a new warning icon with a tool-tip summary of recent task failures.

#1877: The gcylc status bar now shows a countdown to the next suite connection attempt, and resets the connection timer schedule if the user changes view settings.

#1966: Optionally spawn waiting tasks out to "max active cycle points" instead of one cycle point ahead. This means successive instances of the same task can run out of order (dependencies allowing). Use with caution on large suites with a lot of runahead.

#1940: Bash tab completion for cylc commands.

Other Changes

#1585: If a suite stalls, report any unsatisified task prerequisites that cannot be met.

#1944: cylc get-config now returns a valid suite definition.

#1875: Enabled multiple selection in the gcylc text tree view.

#1900: Automatically continue graph string lines that end in (or start with) a dependency arrow.

#1862: New notation for initial and final cycle point in graph cycling section headings. E.g. [[[R1/^+PT1H]]] means "run once, one hour after the initial cycle point"; [[[R1/$-PT1H]]] means "run once, one hour before the final cycle point".

#1928: New notation for excluding a cycle point from a recurrence expression, e.g. [[[T00!^]]] means "daily at T00 after but not including the initial cycle point".

#1958: Suite daemon logging upgrade: improved log file formatting; the log, out, and err files are now rolled over together as soon as any one reaches the size limit.

#1827: Suite state dump files no longer exist - the suite run DB now records all restart information.

#1912: Fixed coloured cylc scan -c output (broken at 6.10.1).

#1921: Don't ignore dependencies among tasks back-inserted prior to a warm-start cycle point.

#1910: Task job scripts now use set -o pipefail to ensure that failure of any part of a shell pipeline causes a job failure.

#1886: When a job is submitted for the first time, any job logs with higher submit numbers will be removed ( these must have been generated by a previous suite run).

#1946: Removed annoying warnings that "self-suicide is not recommended".

#1889: Record any unhandled task messages (e.g. general progress messages) in the suite DB.

#1899: Custom task output messages (for message triggers) are now automatically faked in dummy mode.


cylc-6.10.2 (2016-06-02)

Highlighted Changes

#1848: Automatic stalled-suite detection, a "stalled" event hook, and an option to abort (shutdown) if stalled.

#1850: Much reduced CPU loading in cycling suites that have progressed far beyond their initial cycle point (cache recent points to avoid continually iterating from the start).

#1836: New gscan.rc file to configure the initial state of cylc gpanel and cylc gscan (e.g. which columns to display).

#1849: New configuration options for the gcylc GUI, e.g. to set the initial window size.

Other Changes

#1863: Report tasks added or removed by a suite reload.

#1844: Allow client commands from another suite's task (these would previously load the passphrase for the parent suite rather than the target suite).

#1866: Allow explicitly unset intervals in cylc config files, e.g. execution timeout = # (nothing).

#1863: Fixed a recent bug (since in 6.10.0) causing shutdown on reload of a suite after removing a task and its runtime definition.

#1864: Stronger checks to prevent users starting a second instance of a suite that is already running.

#1869: Fixed day-of-week cycling.

#1858: Fixed a recent bug (since 6.10.1) that could prevent a task at suite start-up from submitting even though its prerequisites were satisfied.

#1855: Allow inserted tasks to be released to the waiting immediately, even if the suite is currently quiet.

#1854: Restore wildcards to allow insertion of multiple tasks at once (inadvertently disallowed at 6.10.0).

#1853: Fixed a recent bug (since 6.10.1): reset task outputs to incomplete on manually retriggering or resetting to a pre-run state.


cylc-6.10.1 (2016-05-17)

Highlighted Changes

#1839: gcylc - fix for occasional locked-up blank GUI window at start-up (since 6.8.0, Jan 2016).

#1841: gcylc tree view - fix for excessive CPU load when displaying large suites (since 6.10.0).

#1838: Fix for the suite timeout event timer not resetting on task activity (since 6.10.0).

Other Changes

#1835: Suite reload - reload all tasks at once (previously, current active tasks were reloaded only when they finished, which could result in reloads appearing to take a long time).

#1833: gcylc - initial task state filtering configurable via the gcylc.rc config file.

#1826: Prevent tasks becoming immune to change by suite reload after being orphaned by one reload (i.e. removed from the suite) then re-inserted after another.

#1804: PBS job name length - truncate to 15 characters by default, but can now be configured in global.rc for PBS 13+, which supports longer names.


cylc-6.10.0 (2016-05-04)

Highlighted Changes

#1769, #1809, #1810, #1811, #1812, #1813, #1819: Suite daemon efficiency and memory footprint - significant improvements!

#1777: Faster validation of suites with large inter-dependent families. See also #1791.

#1743: Improved event handling: flexible handlers, built-in email handlers, execute event handlers asynchronously, general suite event handlers.

#1729: gcylc - The File -> Open dialog can now connect to suites running on other scanned hosts.

#1821: Right-click on a cycle-point in the gcylc text tree view to operate on all tasks at that cycle point.

Other Changes

#1714: Further improvements to Jinja2 error reporting.

#1755: Pyro-3.16 is now packaged with with cylc and has been modified to reduce the overhead of repeated calls to socket.gethost*. We will eventually replace it with a new client/server communications layer.

#1807: Dropped support for detaching (or manual completion) tasks.

#1805: gcylc - corrected the suite hold/release button state during active suite reloads.

#1802: Do not unregister running suites or assume that the argument of cylc unregister is a pattern.

#1800: Print a sensible error message for a suite graph section with a zero-width cycling interval.

#1791: Documented how to write suites with efficient inter-family triggering.

#1789: Fixed a bug causing high CPU load in large suites with queued tasks present.

#1788: Fixed a bug that could occasionally result in missing entries in suite run databases.

#1784: Corrected and improved the advice printed at start-up on how to see if a suite is still running.

#1781: Fixed a bug that could disable the right-click menu for some tasks after enabling a filter.

#1768: Client commands like cylc broadcast can now be invoked by tasks on remote hosts that do not share a filesystem with the suite host.

#1763: Remote tasks now load the right suite passphrase even if a locally registered suite has the same name.

#1762: Fixed polling of jobs submitted to loadleveler (broken since 6.8.1).

#1816, #1779: Allow task names that contain family names after a hyphen.


For changes prior to cylc-6.10.0 see doc/changes.html in the cylc source tree.