Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change spawn command name. #3816

Merged
merged 5 commits into from
Sep 15, 2020
Merged

Conversation

hjoliver
Copy link
Member

@hjoliver hjoliver commented Sep 15, 2020

These changes close #3735

After discussion on the Issue and in offline chat, I've gone with cylc set-outputs as the new command name. This should be a more intuitively obvious name for users (it makes the scheduler behave just as if specified outputs had been completed naturally).

Notes:

  • I have not changed the internal method names that action this command, just the user-facing stuff
  • there were already some functional tests that effectively test the command, but only for the default case ("succeeded" outputs); so I've added a functional test to check that setting of custom outputs works.

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).
  • Appropriate tests are included (functional; plus default case coverage by existing tests).
  • Appropriate change log entry included.
  • No documentation update required (will be covered by general Cylc 8 documentation upgrade).
  • No dependency changes.

@hjoliver hjoliver added this to the cylc-8.0a3 milestone Sep 15, 2020
@hjoliver hjoliver self-assigned this Sep 15, 2020
@hjoliver hjoliver marked this pull request as ready for review September 15, 2020 00:41
Copy link
Member

@kinow kinow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not changed the internal method names that action this command, just the user-facing stuff

👍

Without re-creating the virtual environment, cylc spawn gives some Python traceback due to missing module. But after re-creating it, it prints the expected output

(venv) kinow@ranma:~/Development/python/workspace/cylc-flow$ cylc spawn
Error: cylc spawn: unknown utility. Abort.
Type "cylc help all" for a list of utilities.

Also did a grep with IDE, found no occurrences of anything similar to cylc spawn. Great job!

Q: is REG an argument? The usage example doesn't seem to use it. Asking because I'm trying to run a simple test with five 😬

image

@hjoliver
Copy link
Member Author

Q: is REG an argument? The usage example doesn't seem to use it. Asking because I'm trying to run a simple test with five grimacing

Good spotting!

REG stands for "REGistered workflow name" (i.e. from cylc register foo /path/to/foo/flow.cylc). It should be used, I'll fix the help.

(I'll also put an issue up to swap out "REG" for something less obscure, probably "FLOW", in all command help).

Copy link
Member

@dwsutherland dwsutherland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested & working on my machine, tests passed, code LGTM 👍

@dwsutherland dwsutherland merged commit a6f422e into cylc:master Sep 15, 2020
@hjoliver hjoliver deleted the spawn-cmd-rename branch September 15, 2020 04:59
@hjoliver hjoliver modified the milestones: cylc-8.0a3, cylc-8.0b0 Feb 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cylc spawn: command name
3 participants