feat: added a description field to instructions
#2147
Merged
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
leoporoli
approved these changes
Feb 14, 2024
h4ck3rk3y
commented
Feb 14, 2024
...rver/api_container/server/startosis_engine/kurtosis_instruction/upload_files/upload_files.go
Show resolved
Hide resolved
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 15, 2024
🤖 I have created a release *beep* *boop* --- ## [0.86.24](0.86.23...0.86.24) (2024-02-15) ### Features * added a `description` field to instructions ([#2147](#2147)) ([9085cfd](9085cfd)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: kurtosisbot <kurtosisbot@users.noreply.github.com>
mieubrisse
reviewed
Feb 15, 2024
...rver/api_container/server/startosis_engine/kurtosis_instruction/upload_files/upload_files.go
Show resolved
Hide resolved
| @@ -155,6 +155,10 @@ func (builtin *VerifyCapabilities) FillPersistableAttributes(builder *enclave_pl | |||
| builder.SetType(VerifyBuiltinName) | |||
| } | |||
|
|
|||
| func (builtin *VerifyCapabilities) Description() string { | |||
| return fmt.Sprintf("Verifying whether two values meet a certain condition '%v'", builtin.assertion) | |||
There was a problem hiding this comment.
Is it possible to add a bit more info on what those values are?
| @@ -288,3 +288,7 @@ func (builtin *WaitCapabilities) TryResolveWith(instructionsAreEqual bool, _ *en | |||
| func (builtin *WaitCapabilities) FillPersistableAttributes(builder *enclave_plan_persistence.EnclavePlanInstructionBuilder) { | |||
| builder.SetType(WaitBuiltinName) | |||
| } | |||
|
|
|||
| func (builtin *WaitCapabilities) Description() string { | |||
| return fmt.Sprintf("Waiting for at most '%v' for service '%v' to reach a certain state", builtin.timeout, builtin.serviceName) | |||
There was a problem hiding this comment.
Same here; can we give a bit more info on what the certain state is?
core/server/api_container/server/startosis_engine/kurtosis_instruction/tasks/run_sh.go
Show resolved
Hide resolved
core/server/api_container/server/startosis_engine/kurtosis_instruction/tasks/run_python.go
Show resolved
Hide resolved
...iner/server/startosis_engine/kurtosis_instruction/store_service_files/store_service_files.go
Show resolved
Hide resolved
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 16, 2024
Kevin had given some feedback on #2147 ; this PR works on those
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 21, 2024
## Description: This PR uses the new `description` field in the enclave logs viewer. By default this field is now used to render starlark instructions, rather than the raw field (from #2147 ). ### Demo https://github.com/kurtosis-tech/kurtosis/assets/4419574/a1aa4754-f68b-4ea5-8af8-068531db4dab ## Is this change user facing? Yes ## References (if applicable): * briefed on slack.
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.
Description
The description field can be used instead of the full instruction while outputting to the end user
In the CLI this can be accessed using
--description;