feat(deploy): show resource name and id in deploy output#1254
Open
MichaelHogers wants to merge 1 commit intomainfrom
Open
feat(deploy): show resource name and id in deploy output#1254MichaelHogers wants to merge 1 commit intomainfrom
MichaelHogers wants to merge 1 commit intomainfrom
Conversation
Member
|
Since the new format is an extension of the current format, I feel like it would be appropriate to simply call it verbose mode and change the flag to |
Contributor
Author
|
@sorccu what about this latest version |
Contributor
Author
|
@sorccu i've been thinking, can we always return the id, instead of only in verbose mode? i think it is always useful to know the id? |
Member
|
Can you update the description to include an example of how the ID would be used? Also, possibly premature if we change the PR again, but the description now refers to flags that no longer exist. |
7b045a4 to
2568c0e
Compare
Contributor
Author
|
@sorccu Rebased on main, squashed to a single commit, and updated the description with before/after examples. Ready for review when you get a chance. |
b3b170b to
be43c4a
Compare
Add a -v/--verbose flag to `deploy` that shows the resource name and physical ID (UUID) for each created or updated resource. The --verbose flag implies --output, so both flags don't need to be passed together. Without --verbose, deploy output is unchanged.
be43c4a to
df7a62b
Compare
This file contains hidden or 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
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.
Summary
--verbose(-v) flag todeploythat includes the resource name and physical ID (UUID) for each created or updated resource--verboseimplies--output, so no need to pass both--verbose, deploy output is completely unchangedDefault output
With
--outputWith
--verboseExample usage
The ID lets you reference deployed resources programmatically. For example, a CI script that triggers a check run right after deploy:
Or an AI agent parsing deploy output to verify newly deployed checks are green.
Motivation
The deploy API response already contains
physicalId(UUID) for each resource, but the CLI discarded it. Surfacing it behind--verbosemakes deployed resources easier to identify and reference programmatically (e.g. by CI scripts or AI agents that need to act on specific checks after deploy).Chose to gate this behind
--verboserather than showing it by default because some users may have 1000+ checks — adding two extra lines per resource to every deploy would produce a wall of output and could cause issues in CI logs and terminal buffers.Test plan
--verbose— verify name + id appear for created/updated resources--verbose— output unchanged--outputonly — name/id not shown (unchanged behavior)--preview) — verify name shown (no physicalId since it's a dry run)