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.

Sign up for GitHub

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

Fix cylc install help examples #4188

Merged
merged 2 commits into from
Apr 21, 2021
Merged

Fix cylc install help examples #4188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63ca609
Fix cylc install help examples [skip ci]
MetRonnie Apr 21, 2021
b57c2f2
Update changelog [skip ci]
MetRonnie Apr 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ during workflow run and post pause.
[#4168](https://github.com/cylc/cylc-flow/pull/4168) - Fix bug where any
errors during workflow shutdown were not logged.

[#4161](https://github.com/cylc/cylc-flow/pull/4161) - Fix bug in in `cylc install`
where a workflow would be installed with the wrong name.

[#4188](https://github.com/cylc/cylc-flow/pull/4188) - Fix incorrect usage
examples for `cylc install`.

-------------------------------------------------------------------------------
## __cylc-8.0b0 (<span actions:bind='release-date'>Released 2021-03-29</span>)__

Expand Down
8 changes: 4 additions & 4 deletions cylc/flow/scripts/install.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@
# run directory ~/cylc-run/fido/run1
$ cylc install --flow-name=fido
# Install $PWD/bunny/rabbit/flow.cylc as "bunny/rabbit", with run directory
# ~/cylc-run/bunny/rabbit/run1
# Install $PWD/bunny/rabbit/flow.cylc as "rabbit", with run directory
# ~/cylc-run/rabbit/run1
$ cylc install --directory=bunny/rabbit
# Install $PWD/cats/flow.cylc as "cats", overriding the run1, run2, run3 etc
# structure with run directory ~/cylc-run/cats/paws
# Install $PWD/flow.cylc as "cats", if $PWD is ~/cats, overriding the
# run1, run2, run3 etc. structure with run directory ~/cylc-run/cats/paws
$ cylc install --run-name=paws
The same workflow can be installed with multiple names; this results in
Expand Down