Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adopt EnvironmentVariableCollection.description in git extension #184331

Closed
Tyriar opened this issue Jun 5, 2023 · 2 comments · Fixed by #184413
Closed

Adopt EnvironmentVariableCollection.description in git extension #184331

Tyriar opened this issue Jun 5, 2023 · 2 comments · Fixed by #184413
Assignees
Labels
feature-request Request for new features or functionality git GIT issues insiders-released Patch has been released in VS Code Insiders verification-needed Verification of issue is requested verified Verification succeeded
Milestone

Comments

@Tyriar
Copy link
Member

Tyriar commented Jun 5, 2023

There's a new API (#171108) being finalized this month that allows extensions to explain why it's changing environment variables. Adopting this will show additional information when hovering a terminal tab

API:

export interface EnvironmentVariableCollection extends Iterable<[variable: string, mutator: EnvironmentVariableMutator]> {
/**
* A description for the environment variable collection, this will be used to describe the
* changes in the UI.
*/
description: string | MarkdownString | undefined;
}

Current:

image

After description:

image

cc @karrtikr

@Tyriar Tyriar added feature-request Request for new features or functionality git GIT issues labels Jun 5, 2023
@Tyriar Tyriar added this to the June 2023 milestone Jun 5, 2023
Tyriar added a commit that referenced this issue Jun 6, 2023
@VSCodeTriageBot VSCodeTriageBot added unreleased Patch has not yet been released in VS Code Insiders insiders-released Patch has been released in VS Code Insiders and removed unreleased Patch has not yet been released in VS Code Insiders labels Jun 8, 2023
@lszomoru
Copy link
Member

@Tyriar, will you create a test plan item or add verification steps for this? Thanks!

@Tyriar Tyriar added the verification-needed Verification of issue is requested label Jun 26, 2023
@Tyriar
Copy link
Member Author

Tyriar commented Jun 26, 2023

To verify:

  1. For each combination of settings git.terminalGitEditor and git.terminalAuthentication
  2. Open a terminal
  3. Hover the tab
  4. Verify the description next to Git makes sense

@jrieken jrieken added the verified Verification succeeded label Jun 27, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jul 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality git GIT issues insiders-released Patch has been released in VS Code Insiders verification-needed Verification of issue is requested verified Verification succeeded
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants