feat: Task Display names #1690
feat: Task Display names #1690
Conversation
| type: "json", | ||
| }, | ||
| { | ||
| annotation: "display_name", |
There was a problem hiding this comment.
I start thinking we need a central place to note all the "system" annotations, we have a good number of them now. It can be docs, or smth inside the app (better)
There was a problem hiding this comment.
We have the launcherTaskAnnotationSchema.json which takes precedence over this static list, so arguably we could remove this and rely only on the schema.
| {taskId} | ||
| </Text> | ||
| )} | ||
| {displayName !== name && ( |
There was a problem hiding this comment.
"Breaking change". Older pipelines without "displayName" would lose current "description".
There was a problem hiding this comment.
Solution? The fact they were using task id as a description field is less than ideal and is not behaviour we want to encourage going forward.
There was a problem hiding this comment.
I've brought this back in after a little thought. We'll use the new system if a display name is set. Otherwise we'll use the old system.
| }; | ||
|
|
||
| return ( | ||
| <RenameDialog |
There was a problem hiding this comment.
In regards to our last conversation. What if instead of a dialog for this specific case use "inplace editing", similar to how Description editing works now: when user clicks on a task id - it turns into editing input, and applies in blur.
There was a problem hiding this comment.
It's feasible... I went with dialog because it's consistent with how we rename pipelines and subgraphs. I think it's okay for now and I'd prefer to change all of them at once to inline editing if we decide to make that UX switch.
camielvs
force-pushed
the
01-23-feat_task_display_names
branch
2 times, most recently
from
f749f2b to
d08755d
Compare
camielvs
force-pushed
the
01-23-feat_task_display_names
branch
from
d08755d to
072fc93
Compare
camielvs
force-pushed
the
01-23-feat_task_display_names
branch
from
072fc93 to
c182c2a
Compare
camielvs
force-pushed
the
01-23-feat_task_display_names
branch
from
c182c2a to
1bb985a
Compare
Description
Adds a
display_nameannotation to tasks. This will change the displayed name of the task, but not its ID or the component name. It can be changed using the "rename task" action or by editing annotations.The display name will show on:
Note: the rename
display nametask action is not available for subgraphs because they already have their own naming system. However, the display name can still be updated via annotations if desired.rename-tasks-demo.mov (uploaded via Graphite)
Related Issue and Pull requests
Closes https://github.com/Shopify/oasis-frontend/issues/469
Type of Change
Checklist
Screenshots (if applicable)
Test Instructions
Additional Comments