Skip to content

Commit

Permalink
Merge pull request #771 from wxtim/update_upgrade_instructions
Browse files Browse the repository at this point in the history
expanded 7 upgrade instructions a little.
  • Loading branch information
oliver-sanders authored Nov 7, 2024
2 parents 666800d + cd0fe13 commit e8d3bac
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions src/7-to-8/summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,16 @@ Upgrading To Cylc 8
* Major Changes: :ref:`cylc_7_compat_mode`

There have been some configuration changes at Cylc 8.
To upgrade your Cylc 7 suite to a Cylc 8 workflow, first make sure it validates
in Cylc 7 without any warnings, then rename the workflow configuration file
from ``suite.rc`` to ``flow.cylc``, then run ``cylc validate`` in Cylc 8 and
take action on any warnings.
To upgrade your Cylc 7 suite to a Cylc 8 workflow:

#. Using Cylc 7, make sure the configuration validates (``cylc validate``)
without any warnings.
#. Using Cylc 8 check that you can run the workflow. Running Cylc 8 with a
workflow configured with a ``suite.rc`` turns on
:ref:`compatibility mode <cylc_7_compat_mode>`.
#. Rename the workflow configuration file from ``suite.rc`` to ``flow.cylc``.
#. Using Cylc 8 run ``cylc lint --ruleset 728`` and ``cylc validate``. Make
sure that you deal with any warnings produced by these scripts.

.. TODO Add ref to breaking changes section within Major changes, once created,
including optional ouputs.
Expand Down

0 comments on commit e8d3bac

Please sign in to comment.