Skip to content
New issue

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

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

Already on GitHub? # to your account

Split run services by target type #314

Merged

Conversation

EdLeckert
Copy link
Collaborator

This is a continuation of an earlier effort to simplify and clarify action (service) calling. That effort limited the available entities presented by the UI to only those appropriate to the action. This PR was inspired by Issue #313 and is intended to reduce the available selection of parameters available in the UI to the run action depending on the use case.

It has become clear that the only way to effectively do this was to split the run action into multiple actions, one for each type of target entity. This is due to the fact that each entity type (controller, station, and program) takes a different set of parameters: run_seconds and continue_running_stations, only run_seconds, and no parameters, respectively.

Therefore, I have added these new actions:

  • run_once
  • run_station
  • run_program

I have left the run service as-is (with one exception--see below), with the hope that it can be deprecated and removed in the future.

I also noticed that the logic for continue_running_stations was reversed, so that has been corrected. This could be considered a breaking change, but is the only one.

Finally, I have updated the docs (except for non-"en" translations), probably more than I had intended, but I wanted the existing examples to be consistent with the new ones.

I realize this is a bit to take in. Let me know your thoughts.

Copy link

sonarcloud bot commented Oct 5, 2024

@vinteo
Copy link
Owner

vinteo commented Oct 7, 2024

@EdLeckert could you do me a favour and write a small brief about the breaking change that I can put into the release notes. Thank you

@EdLeckert
Copy link
Collaborator Author

Breaking Change: The logic of the run command parameter continue_running_stations has been corrected. Previously, if the value of the parameter was set to true, it would not continue running stations that were already running, and if set to false, it would.

@vinteo vinteo merged commit b3f3ca5 into vinteo:master Oct 8, 2024
6 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants