conf: change suite.rc to flow.cylc #3755

MetRonnie · 2020-08-05T12:03:41Z

These changes partially address #3689

Summary

suite.rc --> flow.cylc
flow.rc & global.rc --> global.cylc
The directory log/suiterc/ --> log/flow-config/
Generally, suiterc in variable names --> flow_config, and generally rc in variable names --> config
- Functional tests: test_header function create_test_globalrc --> create_test_global_config
- Integration tests: (in tests/i/utils/flow_writer.py): flow_writer.suiterc() --> flow_writer.flow_config_str()
- When referring to a file or filename/path (rather than the config itself), generally suiterc --> flow_file
Every other *.rc --> *.cylc

Backwards compatibility

The first time a user cylc runs a directory that contains only suite.rc, it will automatically create a symlink flow.cylc to that suite.rc.
If a user cylc runs an already-registered suite/workflow and flow.cylc doesn't exist (i.e. suite/workflow was run on a previous version of Cylc), it will re-register

(No backwards compatibility for flow.rc)

Best to look at this one commit by commit. The commits called "Wider rename..." usually consist of the same change done across many files, so you probably only need to take a look at a couple of the files in those.

Requirements check-list

I have read CONTRIBUTING.md and added my name as a Code Contributor.
Contains logically grouped changes (else tidy your branch by rebase).
Does not contain off-topic changes (use other PRs for other changes).

Tests for "upgrading" existing suite.rc to flow.cylc included

Appropriate change log entry included.

(master branch) I have opened a documentation PR at Change suite.rc to flow.cylc cylc-doc#142

No dependency changes.

cylc/flow/suite_files.py

If a workflow dir only has 'suite.rc' on first run, automatically create a symlink 'flow.cylc' to that 'suite.rc' in the register suite step

oliver-sanders · 2020-08-06T19:44:24Z

cylc/flow/cfgspec/globalcfg.py

@@ -87,21 +87,21 @@



You will need to rename the configuration file at line 37.

Do you mean flow.rc? Would it make sense to split that off into another PR?

Ah, just read the PR description, I would have thought it would be easier to do both at the same time, but if you want to do it in two PRs that's ok.

cylc/flow/etc/syntax/cylc.vim

cylc/flow/etc/syntax/cylc.lang

cylc/flow/etc/syntax/cylc-mode.el

cylc/flow/etc/syntax/cylc.xml

cylc/flow/suite_files.py

oliver-sanders · 2020-08-07T10:47:10Z

If a user cylc runs an already-registered suite/workflow and flow.cylc doesn't exist (i.e. suite/workflow was run on a previous version of Cylc), it will re-register

is this overkill

No, it's a really valuable feature for those using Cylc without Rose.

For those using Cylc with Rose it's a potential trap, but that's something we can address with the rose suite-run work later on.

…e.rc

hjoliver · 2020-08-10T21:43:47Z

The directory log/suiterc/ --> log/flow_config/

A very minor point, but the cylc-run directory uses - rather than _, so for consistency I'd prefer flow-config here.

Actually maybe just config or conf would do - we're not going to be storing other config info here are we?

MetRonnie · 2020-08-11T08:53:04Z

maybe just config or conf would do - we're not going to be storing other config info here are we?

As a relative newcomer, I feel that including "flow" in the name makes its purpose clearer.

hjoliver

LGTM 👍

cylc/flow/cfgspec/globalcfg.py

cylc/flow/cfgspec/suite.py

cylc/flow/parsec/README.md

cylc/flow/scripts/cylc_graph.py

- Reduce verbosity of docs

Ensure suite / workflow is registered in that case

Plus alter docs notes on .rc -> .cylc slightly

hjoliver

(Re-approved after a quick scroll through "Files changed")

for cases such as `cylc validate .` where the dir only contains deprecated suite.rc

MetRonnie · 2020-08-13T14:30:05Z

Just pushed one last change because commands like cylc validate . weren't working for suites like ~/cylc-run/foo/bar/ (i.e. the suite name is a bunch of nested directories) with only suite.rc present

…hanges

tests/unit/test_pathutil.py

tests/functional/shutdown/10-no-port-file/flow.cylc

tests/functional/shutdown/11-bad-port-file/flow.cylc

tests/functional/validate/08-whitespace/flow.cylc

tests/functional/deprecations/03-suiterc.t

- Remove previously conflicting files that were deleted on master - Put trailing spaces back in whitespace test - (Also fix call to missing function in cylc-scan sigstop test)

oliver-sanders · 2020-08-18T11:03:55Z

I think we are good to go!

MetRonnie added this to the cylc-8.0a3 milestone Aug 5, 2020

MetRonnie self-assigned this Aug 5, 2020

MetRonnie commented Aug 5, 2020

View reviewed changes

cylc/flow/suite_files.py Outdated Show resolved Hide resolved

MetRonnie mentioned this pull request Aug 5, 2020

conf: configuration file changes #3689

Closed

5 tasks

hjoliver reviewed Aug 6, 2020

View reviewed changes

cylc/flow/suite_files.py Outdated Show resolved Hide resolved

MetRonnie force-pushed the config-changes branch 2 times, most recently from 3fb6336 to 1e718cb Compare August 6, 2020 16:39

MetRonnie changed the title ~~Configuration file changes~~ conf: change suite.rc to flow.cylc Aug 6, 2020

MetRonnie added 2 commits August 6, 2020 18:20

Deprecate suite.rc in favour of flow.cylc

b116843

If a workflow dir only has 'suite.rc' on first run, automatically create a symlink 'flow.cylc' to that 'suite.rc' in the register suite step

Wider rename of suite.rc -> flow.cylc

11d3c95

MetRonnie force-pushed the config-changes branch from 1e718cb to 43a3cfd Compare August 6, 2020 17:20

oliver-sanders reviewed Aug 7, 2020

View reviewed changes

Update syntax highlighters with flow.cylc filetype

690234f

MetRonnie force-pushed the config-changes branch from 43a3cfd to 14335cb Compare August 7, 2020 10:00

MetRonnie force-pushed the config-changes branch from 14335cb to 434580a Compare August 7, 2020 11:30

MetRonnie added 3 commits August 7, 2020 13:36

Wider rename of suite.rc -> flow.cylc

dc158e8

On run, re-register previously-run workflows that use deprecated suit…

9a5260b

…e.rc

Rename suiterc -> flow_file

a759049

MetRonnie force-pushed the config-changes branch from 434580a to b27cc08 Compare August 7, 2020 12:37

MetRonnie linked an issue Aug 7, 2020 that may be closed by this pull request

conf: configuration file changes #3689

Closed

5 tasks

MetRonnie force-pushed the config-changes branch from b27cc08 to 871cf49 Compare August 7, 2020 17:48

MetRonnie mentioned this pull request Aug 7, 2020

Change suite.rc to flow.cylc cylc/cylc-doc#142

Merged

MetRonnie force-pushed the config-changes branch 2 times, most recently from 19b6f7c to ebe72b7 Compare August 10, 2020 17:58

MetRonnie added 3 commits August 11, 2020 10:35

Rename log/suiterc/ dir to log/flow-config/

b4e2847

Wider rename of suite.rc -> flow.cylc

c5fdfc2

Wider rename of suite.rc -> flow.cylc

db2faec

hjoliver approved these changes Aug 12, 2020

View reviewed changes

cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved

cylc/flow/cfgspec/suite.py Outdated Show resolved Hide resolved

cylc/flow/parsec/README.md Show resolved Hide resolved

cylc/flow/scripts/cylc_graph.py Show resolved Hide resolved

MetRonnie added 5 commits August 12, 2020 10:55

Address code review

2d9415a

- Reduce verbosity of docs

Fix cylc validate . when using deprecated suite.rc

399cc47

Ensure suite / workflow is registered in that case

Functional test for upgrading suite.rc -> flow.cylc on registration

ee666f8

Merge branch 'master' into config-changes

e7e3756

Update changelog

fe497cb

Plus alter docs notes on .rc -> .cylc slightly

MetRonnie force-pushed the config-changes branch from 111aa34 to fe497cb Compare August 13, 2020 10:55

Wider rename of .rc -> .cylc

29c61b4

MetRonnie force-pushed the config-changes branch from be1bf06 to 29c61b4 Compare August 13, 2020 12:00

MetRonnie marked this pull request as ready for review August 13, 2020 12:26

MetRonnie requested review from oliver-sanders and hjoliver August 13, 2020 12:26

hjoliver approved these changes Aug 13, 2020

View reviewed changes

Improve parse_suite_arg

b470c5d

for cases such as `cylc validate .` where the dir only contains deprecated suite.rc

MetRonnie added 2 commits August 17, 2020 10:36

Merge commit '1895c13bf8852591d0935d935d16e0b0ee363dac' into config-c…

d1d567c

…hanges

Fix code style

a757f04

MetRonnie commented Aug 17, 2020

View reviewed changes

tests/unit/test_pathutil.py Show resolved Hide resolved

MetRonnie mentioned this pull request Aug 17, 2020

Change .rc -> .cylc cylc/cylc-sphinx-extensions#30

Merged

oliver-sanders reviewed Aug 17, 2020

View reviewed changes

Address code review

ee20de9

- Remove previously conflicting files that were deleted on master - Put trailing spaces back in whitespace test - (Also fix call to missing function in cylc-scan sigstop test)

MetRonnie force-pushed the config-changes branch from fa6ae2f to ee20de9 Compare August 18, 2020 10:07

oliver-sanders approved these changes Aug 18, 2020

View reviewed changes

oliver-sanders merged commit abd4728 into cylc:master Aug 18, 2020

MetRonnie deleted the config-changes branch August 18, 2020 11:32

MetRonnie mentioned this pull request Aug 24, 2020

Rename _rc -> _config #3786

Merged

7 tasks

oliver-sanders mentioned this pull request Sep 1, 2020

async util: handle empty dirs better #3797

Merged

hjoliver modified the milestones: cylc-8.0a3, cylc-8.0b0 Feb 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

conf: change suite.rc to flow.cylc #3755

conf: change suite.rc to flow.cylc #3755

MetRonnie commented Aug 5, 2020 •

edited

Loading

oliver-sanders Aug 6, 2020

MetRonnie Aug 7, 2020

oliver-sanders Aug 7, 2020 •

edited

Loading

oliver-sanders commented Aug 7, 2020 •

edited

Loading

hjoliver commented Aug 10, 2020

MetRonnie commented Aug 11, 2020

hjoliver left a comment

hjoliver left a comment

MetRonnie commented Aug 13, 2020 •

edited

Loading

oliver-sanders commented Aug 18, 2020

conf: change suite.rc to flow.cylc #3755

conf: change suite.rc to flow.cylc #3755

Conversation

MetRonnie commented Aug 5, 2020 • edited Loading

Summary

Backwards compatibility

oliver-sanders Aug 6, 2020

Choose a reason for hiding this comment

MetRonnie Aug 7, 2020

Choose a reason for hiding this comment

oliver-sanders Aug 7, 2020 • edited Loading

Choose a reason for hiding this comment

oliver-sanders commented Aug 7, 2020 • edited Loading

hjoliver commented Aug 10, 2020

MetRonnie commented Aug 11, 2020

hjoliver left a comment

Choose a reason for hiding this comment

hjoliver left a comment

Choose a reason for hiding this comment

MetRonnie commented Aug 13, 2020 • edited Loading

oliver-sanders commented Aug 18, 2020

MetRonnie commented Aug 5, 2020 •

edited

Loading

oliver-sanders Aug 7, 2020 •

edited

Loading

oliver-sanders commented Aug 7, 2020 •

edited

Loading

MetRonnie commented Aug 13, 2020 •

edited

Loading