Skip to content

Clarify behaviour of cmdlet Update-SessionEnvironment #1318

@AdmiringWorm

Description

@AdmiringWorm

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

When a maintainer or user makes use of the Update-SessionEnvironment variable, they may think that it will affect the running session of the users PowerShell session, instead of just the session that the package is running in.

Describe The Solution. Why is it needed?

We need to clarify what we are talking about when mentioning the current session when the Update-SessionEnvironment cmdlet is being used, and who or what will see the changes that gets updated/refreshed.

For example, if the Update-SessionEnvironment is being called inside of a package, only the package that calls it will have any updated or refreshed environment variables, other remaining packages that gets installed will be unaffected, as well as the user session that called choco will also be unaffected and need to call the same cmdlet themself.

User Story

I as a maintainer of Chocolatey packages
want to know what gets affected
so I can take appropriate measures during decisions in the package, or recommendations to the user.

Additional Context

The page that needs to be updated is: https://docs.chocolatey.org/en-us/create/cmdlets/update-sessionenvironment/

After that is updated, the next version of Chocolatey CLI needs to have the help documentation re-generated.

This issue was created as part of a comment made by a user recommending clarifications: chocolatey/choco#3865 (comment)

Acceptance Criteria

  • Documentation has been updated with a clarification

Related Issues

chocolatey/choco#3865

Metadata

Metadata

Assignees

No one assigned

    Labels

    EnhancementIssues that introduce new functionality to the project, or enhances/updates existing functionality.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions