Skip to content

Commit b5df2e3

Browse files
authored
Update release notes for PSReadLine (#12293)
1 parent d6e2d31 commit b5df2e3

File tree

11 files changed

+164
-39
lines changed

11 files changed

+164
-39
lines changed

reference/5.1/PSReadLine/About/about_PSReadLine.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 03/03/2025
4+
ms.date: 08/18/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-5.1&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -124,8 +124,11 @@ APIs are documented in [about_PSReadLine_Functions][02].
124124
### Command History
125125

126126
PSReadLine maintains a history file containing all the commands and data you've
127-
entered from the command line. The history files are a file named
128-
`$($Host.Name)_history.txt`. On Windows systems the history file is stored at
127+
entered from the command line. The history file is a file named
128+
`$($Host.Name)_history.txt`, which results in a unique file for each host. For
129+
example, the history file for the PowerShell Extension console in Visual Studio
130+
Code is `Visual Studio Code Host_history.txt`.
131+
The history file is stored at
129132
`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`.
130133

131134
The history can contain sensitive data including passwords. PSReadLine attempts

reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: This article contains the list of changes for each released version of PSReadLine.
33
Locale: en-US
4-
ms.date: 03/03/2025
4+
ms.date: 08/18/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-5.1&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine_Release_Notes
@@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01].
1919
There have been many updates to PSReadLine since the version that ships in
2020
Windows PowerShell 5.1.
2121

22-
- v2.3.6 shipped in PowerShell 7.5.0
22+
- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0
2323
- v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2424
- v2.3.4 shipped in PowerShell 7.4.0-rc.1
2525
- v2.2.6 shipped in PowerShell 7.3.0
@@ -29,7 +29,33 @@ Windows PowerShell 5.1.
2929

3030
## Release Notes
3131

32-
### v2.4.0-beta1 - 2025-02-28
32+
### v2.4.3-beta3 - 2025-07-23
33+
34+
You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell
35+
Gallery.
36+
37+
This release includes the following changes:
38+
39+
- Allow accepting the current input automatically from within an OnIdle event
40+
handler
41+
- Add VS Code tasks and debug config
42+
- Add bound check for the cursor top value to InvokePrompt
43+
- Fix typo in SamplePSReadLineProfile.ps1
44+
- Fix line ending and cache some reflection operations
45+
- Improve test reliability by making sure the PSReadLine one-time
46+
initialization is done
47+
48+
### v2.4.2-beta2 - 2025-04-16
49+
50+
You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell
51+
Gallery.
52+
53+
This release includes the following changes:
54+
55+
- Add a private field to indicate if PSReadLine is initialized and ready
56+
- Use CFS for installing module and deploy box for module publish
57+
58+
### v2.4.1-beta1 - 2025-02-28
3359

3460
- Avoid querying for cursor position when it's not necessary
3561
- Handle buffer changes made by an event handler

reference/7.4/PSReadLine/About/about_PSReadLine.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 03/03/2025
4+
ms.date: 08/18/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.4&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -159,11 +159,16 @@ APIs are documented in [about_PSReadLine_Functions][02].
159159
### Command History
160160

161161
PSReadLine maintains a history file containing all the commands and data you've
162-
entered from the command line. The history files are a file named
163-
`$($Host.Name)_history.txt`. On Windows systems the history file is stored at
164-
`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. On non-Windows systems,
165-
the history files are stored at `$Env:XDG_DATA_HOME/powershell/PSReadLine` or
166-
`$Env:HOME/.local/share/powershell/PSReadLine`.
162+
entered from the command line. The history file is a file named
163+
`$($Host.Name)_history.txt`, which results in a unique file for each host. For
164+
example, the history file for the PowerShell Extension console in Visual Studio
165+
Code is `Visual Studio Code Host_history.txt`.
166+
167+
- On Windows systems, the history file is stored at
168+
`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`.
169+
- On non-Windows systems, the history files are stored at
170+
`$Env:XDG_DATA_HOME/powershell/PSReadLine` or
171+
`$Env:HOME/.local/share/powershell/PSReadLine`.
167172

168173
The history can contain sensitive data including passwords. PSReadLine attempts
169174
to filter out sensitive information. Any command lines containing the following

reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: This article contains the list of changes for each released version of PSReadLine.
33
Locale: en-US
4-
ms.date: 03/03/2025
4+
ms.date: 08/18/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.4&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine_Release_Notes
@@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01].
1919
There have been many updates to PSReadLine since the version that ships in
2020
Windows PowerShell 5.1.
2121

22-
- v2.3.6 shipped in PowerShell 7.5.0
22+
- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0
2323
- v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2424
- v2.3.4 shipped in PowerShell 7.4.0-rc.1
2525
- v2.2.6 shipped in PowerShell 7.3.0
@@ -29,7 +29,33 @@ Windows PowerShell 5.1.
2929

3030
## Release Notes
3131

32-
### v2.4.0-beta1 - 2025-02-28
32+
### v2.4.3-beta3 - 2025-07-23
33+
34+
You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell
35+
Gallery.
36+
37+
This release includes the following changes:
38+
39+
- Allow accepting the current input automatically from within an OnIdle event
40+
handler
41+
- Add VS Code tasks and debug config
42+
- Add bound check for the cursor top value to InvokePrompt
43+
- Fix typo in SamplePSReadLineProfile.ps1
44+
- Fix line ending and cache some reflection operations
45+
- Improve test reliability by making sure the PSReadLine one-time
46+
initialization is done
47+
48+
### v2.4.2-beta2 - 2025-04-16
49+
50+
You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell
51+
Gallery.
52+
53+
This release includes the following changes:
54+
55+
- Add a private field to indicate if PSReadLine is initialized and ready
56+
- Use CFS for installing module and deploy box for module publish
57+
58+
### v2.4.1-beta1 - 2025-02-28
3359

3460
- Avoid querying for cursor position when it's not necessary
3561
- Handle buffer changes made by an event handler

reference/7.4/PSReadLine/PSReadLine.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Help Version: 7.4.0.0
44
Locale: en-US
55
Module Guid: 5714753b-2afd-4492-a5fd-01d9e2cff8b5
66
Module Name: PSReadLine
7-
ms.date: 09/17/2024
7+
ms.date: 08/18/2025
88
schema: 2.0.0
99
title: PSReadLine
1010
---
@@ -18,6 +18,7 @@ editing environment in PowerShell.
1818
There have been many updates to PSReadLine since the version that ships in
1919
Windows PowerShell 5.1.
2020

21+
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
2122
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2223
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
2324
- v2.2.6 first shipped in PowerShell 7.3.0
@@ -28,7 +29,7 @@ Windows PowerShell 5.1.
2829
For more information about version differences, see
2930
[about_PSReadLine_Release_Notes](about/about_PSReadLine_Release_Notes.md).
3031

31-
These articles document version 2.3.5 of PSReadLine.
32+
These articles document version 2.3.6 of PSReadLine.
3233

3334
> [!NOTE]
3435
> Beginning with PowerShell 7.0, PowerShell skips auto-loading PSReadLine on

reference/7.5/PSReadLine/About/about_PSReadLine.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 03/03/2025
4+
ms.date: 08/18/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.5&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -159,11 +159,16 @@ APIs are documented in [about_PSReadLine_Functions][02].
159159
### Command History
160160

161161
PSReadLine maintains a history file containing all the commands and data you've
162-
entered from the command line. The history files are a file named
163-
`$($Host.Name)_history.txt`. On Windows systems the history file is stored at
164-
`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. On non-Windows systems,
165-
the history files are stored at `$Env:XDG_DATA_HOME/powershell/PSReadLine` or
166-
`$Env:HOME/.local/share/powershell/PSReadLine`.
162+
entered from the command line. The history file is a file named
163+
`$($Host.Name)_history.txt`, which results in a unique file for each host. For
164+
example, the history file for the PowerShell Extension console in Visual Studio
165+
Code is `Visual Studio Code Host_history.txt`.
166+
167+
- On Windows systems, the history file is stored at
168+
`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`.
169+
- On non-Windows systems, the history files are stored at
170+
`$Env:XDG_DATA_HOME/powershell/PSReadLine` or
171+
`$Env:HOME/.local/share/powershell/PSReadLine`.
167172

168173
The history can contain sensitive data including passwords. PSReadLine attempts
169174
to filter out sensitive information. Any command lines containing the following

reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: This article contains the list of changes for each released version of PSReadLine.
33
Locale: en-US
4-
ms.date: 03/03/2025
4+
ms.date: 08/18/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.5&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine_Release_Notes
@@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01].
1919
There have been many updates to PSReadLine since the version that ships in
2020
Windows PowerShell 5.1.
2121

22-
- v2.3.6 shipped in PowerShell 7.5.0
22+
- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0
2323
- v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2424
- v2.3.4 shipped in PowerShell 7.4.0-rc.1
2525
- v2.2.6 shipped in PowerShell 7.3.0
@@ -29,7 +29,33 @@ Windows PowerShell 5.1.
2929

3030
## Release Notes
3131

32-
### v2.4.0-beta1 - 2025-02-28
32+
### v2.4.3-beta3 - 2025-07-23
33+
34+
You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell
35+
Gallery.
36+
37+
This release includes the following changes:
38+
39+
- Allow accepting the current input automatically from within an OnIdle event
40+
handler
41+
- Add VS Code tasks and debug config
42+
- Add bound check for the cursor top value to InvokePrompt
43+
- Fix typo in SamplePSReadLineProfile.ps1
44+
- Fix line ending and cache some reflection operations
45+
- Improve test reliability by making sure the PSReadLine one-time
46+
initialization is done
47+
48+
### v2.4.2-beta2 - 2025-04-16
49+
50+
You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell
51+
Gallery.
52+
53+
This release includes the following changes:
54+
55+
- Add a private field to indicate if PSReadLine is initialized and ready
56+
- Use CFS for installing module and deploy box for module publish
57+
58+
### v2.4.1-beta1 - 2025-02-28
3359

3460
- Avoid querying for cursor position when it's not necessary
3561
- Handle buffer changes made by an event handler

reference/7.5/PSReadLine/PSReadLine.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Help Version: 7.5.0.0
44
Locale: en-US
55
Module Guid: 5714753b-2afd-4492-a5fd-01d9e2cff8b5
66
Module Name: PSReadLine
7-
ms.date: 09/17/2024
7+
ms.date: 08/18/2025
88
schema: 2.0.0
99
title: PSReadLine
1010
---
@@ -18,6 +18,7 @@ editing environment in PowerShell.
1818
There have been many updates to PSReadLine since the version that ships in
1919
Windows PowerShell 5.1.
2020

21+
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
2122
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2223
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
2324
- v2.2.6 first shipped in PowerShell 7.3.0
@@ -28,7 +29,7 @@ Windows PowerShell 5.1.
2829
For more information about version differences, see
2930
[about_PSReadLine_Release_Notes](about/about_PSReadLine_Release_Notes.md).
3031

31-
These articles document version 2.3.5 of PSReadLine.
32+
These articles document version 2.3.6 of PSReadLine.
3233

3334
> [!NOTE]
3435
> Beginning with PowerShell 7.0, PowerShell skips auto-loading PSReadLine on

reference/7.6/PSReadLine/About/about_PSReadLine.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 03/03/2025
4+
ms.date: 08/18/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.6&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -159,11 +159,16 @@ APIs are documented in [about_PSReadLine_Functions][02].
159159
### Command History
160160

161161
PSReadLine maintains a history file containing all the commands and data you've
162-
entered from the command line. The history files are a file named
163-
`$($Host.Name)_history.txt`. On Windows systems the history file is stored at
164-
`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. On non-Windows systems,
165-
the history files are stored at `$Env:XDG_DATA_HOME/powershell/PSReadLine` or
166-
`$Env:HOME/.local/share/powershell/PSReadLine`.
162+
entered from the command line. The history file is a file named
163+
`$($Host.Name)_history.txt`, which results in a unique file for each host. For
164+
example, the history file for the PowerShell Extension console in Visual Studio
165+
Code is `Visual Studio Code Host_history.txt`.
166+
167+
- On Windows systems, the history file is stored at
168+
`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`.
169+
- On non-Windows systems, the history files are stored at
170+
`$Env:XDG_DATA_HOME/powershell/PSReadLine` or
171+
`$Env:HOME/.local/share/powershell/PSReadLine`.
167172

168173
The history can contain sensitive data including passwords. PSReadLine attempts
169174
to filter out sensitive information. Any command lines containing the following

reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: This article contains the list of changes for each released version of PSReadLine.
33
Locale: en-US
4-
ms.date: 03/03/2025
4+
ms.date: 08/18/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.6&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine_Release_Notes
@@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01].
1919
There have been many updates to PSReadLine since the version that ships in
2020
Windows PowerShell 5.1.
2121

22-
- v2.3.6 shipped in PowerShell 7.5.0
22+
- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0
2323
- v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2424
- v2.3.4 shipped in PowerShell 7.4.0-rc.1
2525
- v2.2.6 shipped in PowerShell 7.3.0
@@ -29,7 +29,33 @@ Windows PowerShell 5.1.
2929

3030
## Release Notes
3131

32-
### v2.4.0-beta1 - 2025-02-28
32+
### v2.4.3-beta3 - 2025-07-23
33+
34+
You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell
35+
Gallery.
36+
37+
This release includes the following changes:
38+
39+
- Allow accepting the current input automatically from within an OnIdle event
40+
handler
41+
- Add VS Code tasks and debug config
42+
- Add bound check for the cursor top value to InvokePrompt
43+
- Fix typo in SamplePSReadLineProfile.ps1
44+
- Fix line ending and cache some reflection operations
45+
- Improve test reliability by making sure the PSReadLine one-time
46+
initialization is done
47+
48+
### v2.4.2-beta2 - 2025-04-16
49+
50+
You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell
51+
Gallery.
52+
53+
This release includes the following changes:
54+
55+
- Add a private field to indicate if PSReadLine is initialized and ready
56+
- Use CFS for installing module and deploy box for module publish
57+
58+
### v2.4.1-beta1 - 2025-02-28
3359

3460
- Avoid querying for cursor position when it's not necessary
3561
- Handle buffer changes made by an event handler

0 commit comments

Comments
 (0)