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

Jump to bottom

vr: restart the workflow with no changes according to user prompt #6354

Open
wants to merge 3 commits into
base: 8.3.x
Choose a base branch
from
Open

vr: restart the workflow with no changes according to user prompt #6354

wants to merge 3 commits into from
+236 −40

Conversation

oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Sep 3, 2024 •
edited
Loading

  • Closes cylc vr - restart with no changes? #6261
  • If there are no changes to reinstall AND the workflow is stopped, rather than just exiting, the cylc vr command will now prompt the user to give them the option of restarting the workflow.
  • This makes them aware there are no changes to reinstall (which may be an error on their part) but still gives them the option of restart without having to edit or rerun the command.

An odd feature to introduce at a bugfix release, however, it's kinda a UX type issue so it might make sense.

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).
  • Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
  • Tests are included (or explain why tests are not needed).
  • Changelog entry included if this is a change that can affect users
  • Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
  • If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

@oliver-sanders oliver-sanders added small could be better Not exactly a bug, but not ideal. labels Sep 3, 2024
@oliver-sanders oliver-sanders added this to the 8.3.4 milestone Sep 3, 2024
@oliver-sanders oliver-sanders self-assigned this Sep 3, 2024
@oliver-sanders oliver-sanders marked this pull request as ready for review September 4, 2024 09:29
@oliver-sanders oliver-sanders modified the milestones: 8.3.4, 8.3.5 Sep 11, 2024
@hjoliver
Copy link
Member

(Looks good, but I haven't done a proper review yet).

@oliver-sanders oliver-sanders changed the base branch from master to 8.3.x September 30, 2024 15:56
@oliver-sanders
Copy link
Member Author

(rebased)

@oliver-sanders oliver-sanders modified the milestones: 8.3.5, 8.3.6 Oct 14, 2024
@oliver-sanders
vr: restart the workflow with no changes according to user prompt
5af333d 
* Closes cylc#6261
* If there are no changes to reinstall AND the workflow is stopped,
  prompt the user to see whether they want to restart it anyway.
* This makes `cylc vr` more useful as the "I want to restart my
  workflow" command.
* But it also ensures that they are aware if no changes are present
  as they might have forgotten to press save or run the command on
  the wrong workflow or whatever.
@oliver-sanders
Copy link
Member Author

(rebased)

wxtim
wxtim reviewed Oct 23, 2024
View reviewed changes
changes.d/6354.feat.md Outdated Show resolved Hide resolved
wxtim

This comment was marked as resolved.

Sign in to view

wxtim
wxtim approved these changes Oct 28, 2024
View reviewed changes
Copy link
Member

@wxtim wxtim left a comment

Choose a reason for hiding this comment

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

Alles Gut!

hjoliver
hjoliver requested changes Nov 5, 2024
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

I'm not sure the logic is quite right here.

cylc/flow/scripts/validate_reinstall.py
# the are no changes to install and the workflow is running
# => there is nothing for us to do here
LOG.warning(
f'{NO_CHANGES_STR}: No reinstall or'
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
f'{NO_CHANGES_STR}: No reinstall or'
f'{NO_CHANGES_STR}: no'

The STR already says that no reinstall is needed.

@hjoliver
Copy link
Member

hjoliver commented Nov 5, 2024 •
edited
Loading

no changes, workflow running

$  cylc vr twt 
...
WARNING - No changes to reinstall: No reinstall or reload required. ✔️
  • good: warns there are no changes, does nothing
$ cylc vr twt --yes
...
# no warning that there are no changes to reinstall ❌ 
Successfully reinstalled.  ❌
  • use of --yes should not make any difference here as there is no prompt to respond to
  • there are no changes, so reinstalling and reloading is pointless

no changes, workflow stopped

$ cylc vr twt
...
WARNING - No changes to reinstall ✔️ 
Restart anyway? [y/n]  ✔️
  • good: warns there are no changes to reinstall, asks if we want to restart anyway
$ cylc vr twt --yes
...
Successfully reinstalled. ❌ 
$ cylc play twt ✔️
  • we should warn there are no changes, and not do a pointless reinstall
  • (--yes is for the "restart anyway" prompt)

@oliver-sanders
Copy link
Member Author

I think that behaviour is as intended (and mostly as before), the --yes argument is not just for the restart-anyway prompt, it also behaves like --force.

I'm guessing you would rather have two separate options for these?

Either way, bumping.

@oliver-sanders oliver-sanders modified the milestones: 8.3.6, 8.3.7 Nov 6, 2024
@hjoliver
Copy link
Member

hjoliver commented Nov 6, 2024 •
edited
Loading

I think that behaviour is as intended (and mostly as before), the --yes argument is not just for the restart-anyway prompt, it also behaves like --force.

  1. Command help only says: --yes [reinstall] Skip interactive prompts.
  2. I'm not aware of any precedent for --yes behaving like --force, so that's a bit surprising
  3. What's the point of supporting forced reinstall when we know there are no changes to update? It can't make any difference.

I'm guessing you would rather have two separate options for these?

Not unless you have a good argument for 3. above - is there any need for forced reinstall of no changes? If there is a need, then yes we should have a separate --force option.

BTW, --force could possibly be taken to imply --yes but not vice versa IMO.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoliver hjoliver hjoliver requested changes

@wxtim wxtim wxtim approved these changes

Requested changes must be addressed to merge this pull request.

Assignees

@oliver-sanders oliver-sanders

Labels
could be better Not exactly a bug, but not ideal. small
Projects
None yet
Milestone
8.3.7
Development

Successfully merging this pull request may close these issues.

cylc vr - restart with no changes?
3 participants
@oliver-sanders @hjoliver @wxtim