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.

Sign up for GitHub

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

Fixes #10696 - Add info about using environment variable #10702

Merged
merged 2 commits into from
Dec 3, 2023
Merged

Fixes #10696 - Add info about using environment variable #10702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9df9793
Add info about using environment variable
sdwheeler Dec 2, 2023
c0c900f
minor edit
sdwheeler Dec 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 25 additions & 15 deletions reference/7.2/Microsoft.PowerShell.Core/About/about_Update_Notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Notifies users on startup of PowerShell that a new version of PowerShell has been released.
Locale: en-US
ms.date: 01/10/2020
ms.date: 12/02/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_update_notifications?view=powershell-7.2&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about Update Notifications
Expand All @@ -22,17 +22,18 @@ queries an online service to determine if a newer version is available.

> [!NOTE]
> While the update check happens during the first session in a given 24-hour
> period, for performance reasons, the notification will only be shown on the
> start of subsequent sessions. Also for performance reasons, the check will
> not start until at least 3 seconds after the session begins.
> period, for performance reasons, PowerShell shows the notification on the
> start of subsequent sessions. Also for performance reasons, the check for
> updates starts 3 seconds after the session begins.
By default, PowerShell subscribes to one of two different notification channels
depending on its version/branch. Supported, Generally Available (GA) versions of
PowerShell only return notifications for updated GA releases. Preview and
Release Candidate (RC) releases notify of updates to preview, RC, and GA
releases.
By default, PowerShell subscribes to different notification channels depending
on its version and branch. Generally Available (GA) versions of PowerShell only
return notifications for updated GA releases. Preview and Release Candidate
(RC) versions notify of updates to preview, RC, and GA releases.

The update notification behavior can be changed using the
## Manage notification behavior

You can change the behavior of the update notification by setting the
`POWERSHELL_UPDATECHECK` environment variable. The following values are
supported:

Expand All @@ -42,14 +43,23 @@ supported:
- Preview/RC releases notify of updates to GA and preview releases
- `LTS` only notifies of updates to long-term-servicing (LTS) GA releases

The following endpoints are currently used for determining the latest version of
each channel:
You must set this environment variable before PowerShell starts. For more
information about setting environment variables, see
[about_Environment_Variables][01].

## Notification endpoints

- `LTS`: https://aka.ms/pwsh-buildinfo-lts
- `Stable`: https://aka.ms/pwsh-buildinfo-stable
- `Preview`: https://aka.ms/pwsh-buildinfo-preview
PowerShell uses the following endpoints for determining the latest version
available for each channel:

- `LTS`: <https://aka.ms/pwsh-buildinfo-lts>
- `Stable`: <https://aka.ms/pwsh-buildinfo-stable>
- `Preview`: <https://aka.ms/pwsh-buildinfo-preview>

The update notification doesn't provide any way to automatically update
PowerShell. In the future, there may be more instructions or capabilities to
update from within PowerShell, but today, you should use the same install
mechanism you used to install PowerShell to update it.

<!-- link references -->
[01]: ../about/about_Environment_Variables.md
40 changes: 25 additions & 15 deletions reference/7.3/Microsoft.PowerShell.Core/About/about_Update_Notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Notifies users on startup of PowerShell that a new version of PowerShell has been released.
Locale: en-US
ms.date: 01/10/2020
ms.date: 12/02/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_update_notifications?view=powershell-7.3&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about Update Notifications
Expand All @@ -22,17 +22,18 @@ queries an online service to determine if a newer version is available.

> [!NOTE]
> While the update check happens during the first session in a given 24-hour
> period, for performance reasons, the notification will only be shown on the
> start of subsequent sessions. Also for performance reasons, the check will
> not start until at least 3 seconds after the session begins.
> period, for performance reasons, PowerShell shows the notification on the
> start of subsequent sessions. Also for performance reasons, the check for
> updates starts 3 seconds after the session begins.

By default, PowerShell subscribes to one of two different notification channels
depending on its version/branch. Supported, Generally Available (GA) versions of
PowerShell only return notifications for updated GA releases. Preview and
Release Candidate (RC) releases notify of updates to preview, RC, and GA
releases.
By default, PowerShell subscribes to different notification channels depending
on its version and branch. Generally Available (GA) versions of PowerShell only
return notifications for updated GA releases. Preview and Release Candidate
(RC) versions notify of updates to preview, RC, and GA releases.

The update notification behavior can be changed using the
## Manage notification behavior

You can change the behavior of the update notification by setting the
`POWERSHELL_UPDATECHECK` environment variable. The following values are
supported:

Expand All @@ -42,14 +43,23 @@ supported:
- Preview/RC releases notify of updates to GA and preview releases
- `LTS` only notifies of updates to long-term-servicing (LTS) GA releases

The following endpoints are currently used for determining the latest version of
each channel:
You must set this environment variable before PowerShell starts. For more
information about setting environment variables, see
[about_Environment_Variables][01].

## Notification endpoints

- `LTS`: https://aka.ms/pwsh-buildinfo-lts
- `Stable`: https://aka.ms/pwsh-buildinfo-stable
- `Preview`: https://aka.ms/pwsh-buildinfo-preview
PowerShell uses the following endpoints for determining the latest version
available for each channel:

- `LTS`: <https://aka.ms/pwsh-buildinfo-lts>
- `Stable`: <https://aka.ms/pwsh-buildinfo-stable>
- `Preview`: <https://aka.ms/pwsh-buildinfo-preview>

The update notification doesn't provide any way to automatically update
PowerShell. In the future, there may be more instructions or capabilities to
update from within PowerShell, but today, you should use the same install
mechanism you used to install PowerShell to update it.

<!-- link references -->
[01]: ../about/about_Environment_Variables.md
40 changes: 25 additions & 15 deletions reference/7.4/Microsoft.PowerShell.Core/About/about_Update_Notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Notifies users on startup of PowerShell that a new version of PowerShell has been released.
Locale: en-US
ms.date: 01/10/2020
ms.date: 12/02/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_update_notifications?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about Update Notifications
Expand All @@ -22,17 +22,18 @@ queries an online service to determine if a newer version is available.

> [!NOTE]
> While the update check happens during the first session in a given 24-hour
> period, for performance reasons, the notification will only be shown on the
> start of subsequent sessions. Also for performance reasons, the check will
> not start until at least 3 seconds after the session begins.
> period, for performance reasons, PowerShell shows the notification on the
> start of subsequent sessions. Also for performance reasons, the check for
> updates starts 3 seconds after the session begins.
By default, PowerShell subscribes to one of two different notification channels
depending on its version/branch. Supported, Generally Available (GA) versions of
PowerShell only return notifications for updated GA releases. Preview and
Release Candidate (RC) releases notify of updates to preview, RC, and GA
releases.
By default, PowerShell subscribes to different notification channels depending
on its version and branch. Generally Available (GA) versions of PowerShell only
return notifications for updated GA releases. Preview and Release Candidate
(RC) versions notify of updates to preview, RC, and GA releases.

The update notification behavior can be changed using the
## Manage notification behavior

You can change the behavior of the update notification by setting the
`POWERSHELL_UPDATECHECK` environment variable. The following values are
supported:

Expand All @@ -42,14 +43,23 @@ supported:
- Preview/RC releases notify of updates to GA and preview releases
- `LTS` only notifies of updates to long-term-servicing (LTS) GA releases

The following endpoints are currently used for determining the latest version of
each channel:
You must set this environment variable before PowerShell starts. For more
information about setting environment variables, see
[about_Environment_Variables][01].

## Notification endpoints

- `LTS`: https://aka.ms/pwsh-buildinfo-lts
- `Stable`: https://aka.ms/pwsh-buildinfo-stable
- `Preview`: https://aka.ms/pwsh-buildinfo-preview
PowerShell uses the following endpoints for determining the latest version
available for each channel:

- `LTS`: <https://aka.ms/pwsh-buildinfo-lts>
- `Stable`: <https://aka.ms/pwsh-buildinfo-stable>
- `Preview`: <https://aka.ms/pwsh-buildinfo-preview>

The update notification doesn't provide any way to automatically update
PowerShell. In the future, there may be more instructions or capabilities to
update from within PowerShell, but today, you should use the same install
mechanism you used to install PowerShell to update it.

<!-- link references -->
[01]: ../about/about_Environment_Variables.md