Clarify hotReloadCapable field

[feloy]

What does this PR do?

this PR clarifies the meaning of the HotReloadCapable field for a command.

Which issue(s) does this PR fix

redhat-developer/odo#6697

PR acceptance criteria

Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.

• Open new test/doc issues under the devfile/api repo
• Check each criteria if:
• There is a separate tracking issue. Add the issue link under the criteria
  or
• test/doc updates are made as part of this PR
• If unchecked, explain why it's not needed

• Unit/Functional tests

• QE Integration test

• Documentation

• Client Impact

How to test changes / Special notes to the reviewer

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (1df96d2) 35.64% compared to head (161d4cf) 35.64%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1091   +/-   ##
=======================================
  Coverage   35.64%   35.64%           
=======================================
  Files          52       52           
  Lines        6669     6669           
=======================================
  Hits         2377     2377           
  Misses       4147     4147           
  Partials      145      145           

Impacted Files	Coverage Δ
...rkspaces/v1alpha2/zz_generated.parent_overrides.go	0.00% <ø> (ø)
...rkspaces/v1alpha2/zz_generated.plugin_overrides.go	0.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[amisevsk]

If the command is only run once for build commands (which is presumably the case regardless of value), is the field not ignored for build commands as well?

[feloy]

On Odo, without hotReloadCapable to true, build command is executed after each source change, and run command is stopped/restarted after each source change.

[amisevsk]

I'm not sure I understand -- do you mean with hotReloadCapable: true for the odo case? It sounds like with hotReloadCapable: true, the build command runs less often than otherwise.

These are very confusing semantics for hotReloadCapable.

[amisevsk]

Ah nevermind, I thought about it for a moment longer and realized I was confusing myself.

Does this mean that all exec commands come with an implicit watch for file changes? I'm a still a little confused by this behavior, since in my head, a command is something I can opt to run. The line

A hotReloadCapable build command is expected to be executed only once and won't be executed again.

implies that it's expected the command will automatically run at some point (when?)

[feloy]

Yes sorry, I was not explicit on one point: I'm talking about default build and run commands, which are executed automatically by Odo at startup and after each source change.

Also, you have to note the difference between build and run/debug commands:

Build commands are expected to be short-running commands (terminating after build is finished), when run/debug commands are expected to be long-running, stopped only at the end of the dev session. Thus the difference in the description for these 2 kinds of commands

[amisevsk]

Ah that makes sense. It may be worth clarifying this detail, as this doc will appear on all commands. A user may set it and expect behavior to change, even with isDefault: false.

[feloy]

It may be worth clarifying this detail, as this doc will appear on all commands. A user may set it and expect behavior to change, even with isDefault: false.

You are right, I've updated the description. Thanks

[kim-tsao]

I agree, this is a bit of a confusing read that took multiple passes for me to understand. I think I got thrown off by the field description. Can we get that updated to Specify whether the command is restarted or not when the source code changes

I also noticed we are missing license headers in these files. Can we add those?

[feloy]

I agree, this is a bit of a confusing read that took multiple passes for me to understand. I think I got thrown off by the field description. Can we get that updated to Specify whether the command is restarted or not when the source code changes

I've made the change.

I also noticed we are missing license headers in these files. Can we add those?

I can see that none of the files in the package have the header. I would prefer to keep this change for another PR

[yangcao77]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: amisevsk, feloy, kim-tsao

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment