(feat): Warning users about create OSTree static deltas before rolling out waves #285
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
camilamacedo86
changed the title
vkhoroz
reviewed
Sep 28, 2023
camilamacedo86
force-pushed
the
add-warning-before-create-weave-init
branch
3 times, most recently
from
3db8013
to
854ab1c
Compare
mike-sul
reviewed
Oct 2, 2023
mike-sul
reviewed
Oct 2, 2023
mike-sul
reviewed
Oct 2, 2023
mike-sul
reviewed
Oct 2, 2023
camilamacedo86
force-pushed
the
add-warning-before-create-weave-init
branch
3 times, most recently
from
5f63f5e
to
7ded640
Compare
camilamacedo86
changed the title
camilamacedo86
changed the title
camilamacedo86
changed the title
mike-sul
reviewed
Oct 3, 2023
mike-sul
approved these changes
Oct 3, 2023
kprosise
approved these changes
Oct 3, 2023
subcommands/waves/init.go
Outdated
| OTA update download. Please, consider generating a static delta for targets using: | ||
| $ fioctl targets static-deltas | ||
|
|
||
| You can then cancel this wave and create a new one for a target with a static delta. |
There was a problem hiding this comment.
Suggested change
| You can then cancel this wave and create a new one for a target with a static delta. | |
| You can then cancel the wave and create a new one by using a static delta. |
Optional suggestion! Just shortening the sentence a bit.
There was a problem hiding this comment.
@kprosise @camilamacedo86 This suggestion makes a message somewhat misleading.
A user cannot create a wave by using a static delta, but a user can create a wave for a target which has static deltas defined.
So, I suggest to either revert this message to its original, or make a new suggestion which provides a more accurate context to the user.
There was a problem hiding this comment.
I agree. Good point.
…g out waves Signed-off-by: Camila Macedo <[email protected]>
camilamacedo86
force-pushed
the
add-warning-before-create-weave-init
branch
from
7ded640
to
df7ac89
Compare
vkhoroz
reviewed
Oct 3, 2023
There was a problem hiding this comment.
@camilamacedo86 please, make a follow-up PR to address the 2 comments from me.
Comment on lines
+32
to
+33
| We recommend that you generate static deltas for your production targets to optimize | ||
| OTA update download. Consider generating a static delta for targets using: |
There was a problem hiding this comment.
We use the semantic newlines in help messages.
Please, see the related section in the style guide.
Suggested change
| We recommend that you generate static deltas for your production targets to optimize | |
| OTA update download. Consider generating a static delta for targets using: | |
| We recommend that you generate static deltas for your production targets to optimize OTA update download. | |
| Consider generating a static delta for targets using: |
The line length is absolutely irrelevant here, as long as the sentence fits within 25 words.
Comment on lines
+157
to
+163
| WARNING: You created a wave for a target version without static deltas. | ||
|
|
||
| We recommend that you generate static deltas for your production targets to optimize | ||
| OTA update download. Consider generating a static delta for targets using: | ||
| $ fioctl targets static-deltas | ||
|
|
||
| You can then cancel the wave and create a new one by using a static delta. |
There was a problem hiding this comment.
Same about semantic newlines:
Suggested change
| WARNING: You created a wave for a target version without static deltas. | |
| We recommend that you generate static deltas for your production targets to optimize | |
| OTA update download. Consider generating a static delta for targets using: | |
| $ fioctl targets static-deltas | |
| You can then cancel the wave and create a new one by using a static delta. | |
| WARNING: You created a wave for a target version without static deltas. | |
| We recommend that you generate static deltas for your production targets to optimize OTA update download. | |
| Consider generating a static delta for targets using: | |
| $ fioctl targets static-deltas | |
| You can then cancel the wave and create a new one for a target which has static deltas defined. |
This also incorporates my above suggestion about using static deltas.
|
Other than above, this LGTM. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a warning message to inform users about the recommendation to use Static Deltas to optimize OTA downloads.
The message only appears when users create weaves that do not have static deltas.
Local tests:
When no Static Deltas are in place: