feat: deprecate built-in restart workflow action

didier-wenzek commented 5 months ago

Proposed changes

This deprecates the build-in action = restart from user defined operation workflows. A device restart has to be triggered using a sub operation = restart.

Why now? This will ease https://github.com/thin-edge/thin-edge.io/pull/2844 by making all the operations processed the same way.

Types of changes

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
[ ] Documentation Update (if none of the other choices apply)
[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

Checklist

[x] I have read the CONTRIBUTING doc
[x] I have signed the CLA (in all commits with git commit -s)
[x] I ran cargo fmt as mentioned in CODING_GUIDELINES
[x] I used cargo clippy as mentioned in CODING_GUIDELINES
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)

Further comments

github-actions[bot] commented 5 months ago

Robot Results

:white_check_mark: Passed	:x: Failed	:next_track_button: Skipped	Total	Pass %	:stopwatch: Duration
431	0	3	431	100	0s

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.3%. Comparing base (e1e6839) to head (a868ae6). Report is 1 commits behind head on main.

Additional details and impacted files

| [Files](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2852?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge) | Coverage Δ | | |---|---|---| | [...tedge\_agent/src/tedge\_operation\_converter/actor.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2852?src=pr&el=tree&filepath=crates%2Fcore%2Ftedge_agent%2Fsrc%2Ftedge_operation_converter%2Factor.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2NvcmUvdGVkZ2VfYWdlbnQvc3JjL3RlZGdlX29wZXJhdGlvbl9jb252ZXJ0ZXIvYWN0b3IucnM=) | `49.7% <100.0%> (+2.1%)` | :arrow_up: | | [crates/core/tedge\_api/src/commands.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2852?src=pr&el=tree&filepath=crates%2Fcore%2Ftedge_api%2Fsrc%2Fcommands.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2NvcmUvdGVkZ2VfYXBpL3NyYy9jb21tYW5kcy5ycw==) | `89.9% <100.0%> (+6.3%)` | :arrow_up: | | [crates/core/tedge\_api/src/workflow/mod.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2852?src=pr&el=tree&filepath=crates%2Fcore%2Ftedge_api%2Fsrc%2Fworkflow%2Fmod.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2NvcmUvdGVkZ2VfYXBpL3NyYy93b3JrZmxvdy9tb2QucnM=) | `60.5% <ø> (+0.4%)` | :arrow_up: | | [crates/core/tedge\_api/src/workflow/toml\_config.rs](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2852?src=pr&el=tree&filepath=crates%2Fcore%2Ftedge_api%2Fsrc%2Fworkflow%2Ftoml_config.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge#diff-Y3JhdGVzL2NvcmUvdGVkZ2VfYXBpL3NyYy93b3JrZmxvdy90b21sX2NvbmZpZy5ycw==) | `79.0% <ø> (+4.6%)` | :arrow_up: | ... and [8 files with indirect coverage changes](https://app.codecov.io/gh/thin-edge/thin-edge.io/pull/2852/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=thin-edge)

gligorisaev commented 4 months ago

QA has thoroughly checked the feature and here are the results:

[x] Test changes has been reviewed. tests/RobotFramework/tests/tedge_agent/workflows/custom_operation.robot
[x] Documentation changes have been reviewed docs/src/references/agent/operation-workflow.md
[x] QA has tested the function and it's functioning according description.

thin-edge / thin-edge.io