[cli] Add `target` to `vc inspect` output by onsclom · Pull Request #11821 · vercel/vercel

onsclom · 2024-07-09T18:07:59Z

vc inspect did not output target before. This adds target output for existing "staging" and "production" values and custom environment names.

changeset-bot · 2024-07-09T18:08:03Z

🦋 Changeset detected

Latest commit: c87c37c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
vercel	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

…ent-in-vc-inspect-output

If the deployment has a custom environment, the user is flagged into custom environments. Later on, we can always link to the /setting/environments page.

onsclom · 2024-07-09T18:36:47Z

packages/cli/src/commands/inspect/index.ts

  print(`    ${chalk.cyan('name')}\t${name}\n`);
+  // @ts-ignore - customEnvironment needs to be defined on Deployment
+  const customEnvironmentName = deployment.customEnvironment?.name;
+  const target = customEnvironmentName ?? deployment.target;


deployment.target has type "staging" | "production" | "null" | "undefined". Even after spending time digging into this, I'm still unsure what null or undefined values mean.

If the deployment doesn't have a custom environment name, and target is null or undefined, should it default to displaying something?

I think displaying nothing is fine here. Pretty edge-casey.

👋 hello future someone reading this wondering why we didn't handle this case!

null means "preview", so we should special-case that. undefined I think does not ever happen, but probably fine to default that to "preview" as well.

TooTallNate · 2024-07-09T19:41:16Z

packages/cli/src/commands/inspect/index.ts

+    print(
+      // @ts-ignore - customEnvironment needs to be defined on Deployment
+      customEnvironmentName && deployment.team?.slug
+        ? `${link(


I think the consensus we had regarding links is that if the terminal does not support them, don't render the link. That is to say, we should add a fallback (2nd param of the link() function) which returns only the name of the target.

TooTallNate · 2024-07-09T19:41:44Z

Let's add a unit test please.

This means the target is preview.

TooTallNate · 2024-07-10T00:08:03Z

packages/cli/src/commands/inspect/index.ts

+      customEnvironmentName && deployment.team?.slug
+        ? `${link(
+            `${target}`,
+            `https://vercel.com/${deployment.team.slug}/${name}/settings/environments`,


I think we should link to the specific target's page.

…ent-in-vc-inspect-output

TooTallNate · 2024-07-12T17:12:56Z

packages/cli/src/commands/inspect/index.ts

        ? `${link(
            `${target}`,
-            `https://vercel.com/${deployment.team.slug}/${name}/settings/environments`,
+            // @ts-ignore - customEnvironment needs to be defined on Deployment


I would suggest @ts-expect-error instead. But also, can we add the type to Deployment so it's not necessary?

TooTallNate · 2024-07-12T18:13:07Z

packages/cli/src/commands/inspect/index.ts

  print(`    ${chalk.cyan('name')}\t${name}\n`);
+  const customEnvironmentName = deployment.customEnvironment?.name;
+  const target = customEnvironmentName ?? deployment.target ?? 'preview';
+  if (target) {


This will always be truthy

…ent-in-vc-inspect-output

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## [email protected] ### Minor Changes - Add target output to `vc inspect` ([#11821](#11821)) - Send `customEnvironmentSlugOrId` to the create deployment endpoint ([#11789](#11789)) - Add `vc target ls` command ([#11790](#11790)) ### Patch Changes - Various improvements to vc target ls ([#11840](#11840)) - Updated dependencies \[[`3eb40c8c2`](3eb40c8), [`d0fe663af`](d0fe663), [`b1e4a4011`](b1e4a40), [`55ab52512`](55ab525)]: - @vercel/[email protected] - @vercel/[email protected] - @vercel/[email protected] - @vercel/[email protected] - @vercel/[email protected] ## @vercel/[email protected] ### Minor Changes - Send `customEnvironmentSlugOrId` to the create deployment endpoint ([#11789](#11789)) ### Patch Changes - Updated dependencies \[[`3eb40c8c2`](3eb40c8)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - reject mismatched corepack and detected package managers ([#11603](#11603)) ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[[`3eb40c8c2`](3eb40c8)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - Ensure we do not include ending slash in matched path ([#11830](#11830)) ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[[`3eb40c8c2`](3eb40c8)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - Update `@remix-run/dev` fork to v2.10.2 ([#11837](#11837)) ## @vercel/[email protected] ### Patch Changes - [framework-fixtures]: Bump the core group across 1 directory with 3 updates ([#11773](#11773)) - Updated dependencies \[]: - @vercel/[email protected] ## @vercel-internals/[email protected] ### Patch Changes - Updated dependencies \[[`3eb40c8c2`](3eb40c8)]: - @vercel/[email protected] Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Print target in inspect command

da0719b

Add changeset

a83d2d7

onsclom force-pushed the austinmerrick/zero-2020-show-custom-environment-in-vc-inspect-output branch from 345b9de to a83d2d7 Compare July 9, 2024 18:10

Merge branch 'main' into austinmerrick/zero-2020-show-custom-environm…

f0a0db8

…ent-in-vc-inspect-output

vercel bot deployed to Preview July 9, 2024 18:12 View deployment

Make target a link if the deployment has a custom environment

b515ff9

If the deployment has a custom environment, the user is flagged into custom environments. Later on, we can always link to the /setting/environments page.

vercel bot deployed to Preview July 9, 2024 18:33 View deployment

onsclom commented Jul 9, 2024

View reviewed changes

onsclom marked this pull request as ready for review July 9, 2024 18:41

onsclom requested review from EndangeredMassa, TooTallNate, erikareads, jeffsee55 and trek as code owners July 9, 2024 18:41

trek previously approved these changes Jul 9, 2024

View reviewed changes

TooTallNate reviewed Jul 9, 2024

View reviewed changes

onsclom added 3 commits July 9, 2024 13:16

Handle case of deployment.target being null

f3cf5b4

This means the target is preview.

Stop rendering link in fallback case

ddfac40

Add unit test for target

7eddb45

onsclom dismissed trek’s stale review via 7eddb45 July 9, 2024 21:54

vercel bot deployed to Preview July 9, 2024 21:55 View deployment

TooTallNate reviewed Jul 10, 2024

View reviewed changes

onsclom and others added 2 commits July 10, 2024 09:25

Link to specific targets page

439307c

Merge branch 'main' into austinmerrick/zero-2020-show-custom-environm…

d10da98

…ent-in-vc-inspect-output

vercel bot deployed to Preview July 10, 2024 16:27 View deployment

onsclom requested a review from TooTallNate July 10, 2024 16:31

Merge branch 'main' into austinmerrick/zero-2020-show-custom-environm…

17310bc

…ent-in-vc-inspect-output

vercel bot deployed to Preview July 11, 2024 16:25 View deployment

onsclom added the pr: automerge label Jul 12, 2024

TooTallNate reviewed Jul 12, 2024

View reviewed changes

vercel bot deployed to Preview July 12, 2024 17:35 View deployment

onsclom added 2 commits July 12, 2024 10:38

Add types to deployment

3dfd132

Reuse types in mocks

d6c3f42

onsclom force-pushed the austinmerrick/zero-2020-show-custom-environment-in-vc-inspect-output branch from 15ae743 to d6c3f42 Compare July 12, 2024 17:38

vercel bot deployed to Preview July 12, 2024 17:39 View deployment

Remove remaining ignore

a57aadc

vercel bot deployed to Preview July 12, 2024 17:45 View deployment

Fix type error

dd61355

vercel bot deployed to Preview July 12, 2024 17:52 View deployment

Remove unnecessary '?'

8f5fa0d

vercel bot deployed to Preview July 12, 2024 17:55 View deployment

TooTallNate reviewed Jul 12, 2024

View reviewed changes

Remove unnecessary if statement

a379a84

vercel bot deployed to Preview July 12, 2024 18:25 View deployment

onsclom requested a review from TooTallNate July 12, 2024 18:34

Add color false

4dbab8e

vercel bot deployed to Preview July 12, 2024 18:38 View deployment

Remove stray "}"

98f2a96

vercel bot deployed to Preview July 12, 2024 18:42 View deployment

Fix fallback

ad6fcd9

TooTallNate approved these changes Jul 12, 2024

View reviewed changes

vercel bot deployed to Preview July 12, 2024 19:00 View deployment

Merge branch 'main' into austinmerrick/zero-2020-show-custom-environm…

c87c37c

…ent-in-vc-inspect-output

vercel bot deployed to Preview July 12, 2024 19:24 View deployment

kodiakhq bot merged commit cf578d6 into main Jul 12, 2024

kodiakhq bot deleted the austinmerrick/zero-2020-show-custom-environment-in-vc-inspect-output branch July 12, 2024 19:27

vercel-release-bot mentioned this pull request Jul 12, 2024

Version Packages #11819

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[cli] Add `target` to `vc inspect` output#11821

[cli] Add `target` to `vc inspect` output#11821
kodiakhq[bot] merged 21 commits intomainfrom
austinmerrick/zero-2020-show-custom-environment-in-vc-inspect-output

onsclom commented Jul 9, 2024 •

edited

Loading

Uh oh!

changeset-bot bot commented Jul 9, 2024 •

edited

Loading

Uh oh!

onsclom Jul 9, 2024 •

edited

Loading

Uh oh!

trek Jul 9, 2024

Uh oh!

TooTallNate Jul 9, 2024 •

edited

Loading

Uh oh!

TooTallNate Jul 9, 2024

Uh oh!

TooTallNate commented Jul 9, 2024

Uh oh!

TooTallNate Jul 10, 2024

Uh oh!

TooTallNate Jul 12, 2024

Uh oh!

TooTallNate Jul 12, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

onsclom commented Jul 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Jul 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

onsclom Jul 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trek Jul 9, 2024

Choose a reason for hiding this comment

Uh oh!

TooTallNate Jul 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TooTallNate Jul 9, 2024

Choose a reason for hiding this comment

Uh oh!

TooTallNate commented Jul 9, 2024

Uh oh!

TooTallNate Jul 10, 2024

Choose a reason for hiding this comment

Uh oh!

TooTallNate Jul 12, 2024

Choose a reason for hiding this comment

Uh oh!

TooTallNate Jul 12, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

onsclom commented Jul 9, 2024 •

edited

Loading

changeset-bot bot commented Jul 9, 2024 •

edited

Loading

onsclom Jul 9, 2024 •

edited

Loading

TooTallNate Jul 9, 2024 •

edited

Loading