Merge pull request #12294 from MicrosoftDocs/main

Auto Publish – main to live - 2025-08-18 22:00 UTC

Author: learn-build-service-prod[bot]

.github/workflows/checklist.yml

@@ -24,7 +24,7 @@ jobs:
     steps:
       - name: Checkout Repository
         id: checkout_repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Verify Checklist
         id: verify_checklist
         uses: ./.github/actions/verification/checklist/v1

.github/workflows/expectations.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
       - name: Checkout Repository
         id: checkout_repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Comment on Community PRs
         uses: ./.github/actions/commenting/expectations/v1
         with:

.github/workflows/stale-content.yml

@@ -22,7 +22,7 @@ jobs:
     steps:
       - name: Checkout Repository
         id: checkout_repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Write Report
         uses: ./.github/actions/reporting/stale-content/v1
         with:

.github/workflows/targeting-repo-files.yml

@@ -29,7 +29,7 @@ jobs:
     steps:
       - name: Checkout Repository
         id: checkout_repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Authorized to Modify Repo Files?
         uses: ./.github/actions/verification/authorization/v1
         with:

.github/workflows/targeting-valid-branch.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
       - name: Checkout Repository
         id: checkout_repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Authorized to Target Live Branch?
         uses: ./.github/actions/verification/authorization/v1
         with:

.github/workflows/versioned-content.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
       - name: Checkout Repository
         id: checkout_repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Write Report
         uses: ./.github/actions/reporting/versioned-content/v1
         with:

reference/5.1/PSReadLine/About/about_PSReadLine.md

@@ -1,7 +1,7 @@
 ---
 description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
 Locale: en-US
-ms.date: 03/03/2025
+ms.date: 08/18/2025
 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-5.1&WT.mc_id=ps-gethelp
 schema: 2.0.0
 title: about_PSReadLine
@@ -124,8 +124,11 @@ APIs are documented in [about_PSReadLine_Functions][02].
 ### Command History
 
 PSReadLine maintains a history file containing all the commands and data you've
-entered from the command line. The history files are a file named
-`$($Host.Name)_history.txt`. On Windows systems the history file is stored at
+entered from the command line. The history file is a file named
+`$($Host.Name)_history.txt`, which results in a unique file for each host. For
+example, the history file for the PowerShell Extension console in Visual Studio
+Code is `Visual Studio Code Host_history.txt`.
+The history file is stored at
 `$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`.
 
 The history can contain sensitive data including passwords. PSReadLine attempts

reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md

@@ -1,7 +1,7 @@
 ---
 description: This article contains the list of changes for each released version of PSReadLine.
 Locale: en-US
-ms.date: 03/03/2025
+ms.date: 08/18/2025
 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-5.1&WT.mc_id=ps-gethelp
 schema: 2.0.0
 title: about_PSReadLine_Release_Notes
@@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01].
 There have been many updates to PSReadLine since the version that ships in
 Windows PowerShell 5.1.
 
-- v2.3.6 shipped in PowerShell 7.5.0
+- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0
 - v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3
 - v2.3.4 shipped in PowerShell 7.4.0-rc.1
 - v2.2.6 shipped in PowerShell 7.3.0
@@ -29,7 +29,33 @@ Windows PowerShell 5.1.
 
 ## Release Notes
 
-### v2.4.0-beta1 - 2025-02-28
+### v2.4.3-beta3 - 2025-07-23
+
+You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell
+Gallery.
+
+This release includes the following changes:
+
+- Allow accepting the current input automatically from within an OnIdle event
+  handler
+- Add VS Code tasks and debug config
+- Add bound check for the cursor top value to InvokePrompt
+- Fix typo in SamplePSReadLineProfile.ps1
+- Fix line ending and cache some reflection operations
+- Improve test reliability by making sure the PSReadLine one-time
+  initialization is done
+
+### v2.4.2-beta2 - 2025-04-16
+
+You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell
+Gallery.
+
+This release includes the following changes:
+
+- Add a private field to indicate if PSReadLine is initialized and ready
+- Use CFS for installing module and deploy box for module publish
+
+### v2.4.1-beta1 - 2025-02-28
 
 - Avoid querying for cursor position when it's not necessary
 - Handle buffer changes made by an event handler

reference/7.4/PSReadLine/About/about_PSReadLine.md

@@ -1,7 +1,7 @@
 ---
 description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
 Locale: en-US
-ms.date: 03/03/2025
+ms.date: 08/18/2025
 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.4&WT.mc_id=ps-gethelp
 schema: 2.0.0
 title: about_PSReadLine
@@ -159,11 +159,16 @@ APIs are documented in [about_PSReadLine_Functions][02].
 ### Command History
 
 PSReadLine maintains a history file containing all the commands and data you've
-entered from the command line. The history files are a file named
-`$($Host.Name)_history.txt`. On Windows systems the history file is stored at
-`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. On non-Windows systems,
-the history files are stored at `$Env:XDG_DATA_HOME/powershell/PSReadLine` or
-`$Env:HOME/.local/share/powershell/PSReadLine`.
+entered from the command line. The history file is a file named
+`$($Host.Name)_history.txt`, which results in a unique file for each host. For
+example, the history file for the PowerShell Extension console in Visual Studio
+Code is `Visual Studio Code Host_history.txt`.
+
+- On Windows systems, the history file is stored at
+  `$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`.
+- On non-Windows systems, the history files are stored at
+  `$Env:XDG_DATA_HOME/powershell/PSReadLine` or
+  `$Env:HOME/.local/share/powershell/PSReadLine`.
 
 The history can contain sensitive data including passwords. PSReadLine attempts
 to filter out sensitive information. Any command lines containing the following

reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md

@@ -1,7 +1,7 @@
 ---
 description: This article contains the list of changes for each released version of PSReadLine.
 Locale: en-US
-ms.date: 03/03/2025
+ms.date: 08/18/2025
 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.4&WT.mc_id=ps-gethelp
 schema: 2.0.0
 title: about_PSReadLine_Release_Notes
@@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01].
 There have been many updates to PSReadLine since the version that ships in
 Windows PowerShell 5.1.
 
-- v2.3.6 shipped in PowerShell 7.5.0
+- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0
 - v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3
 - v2.3.4 shipped in PowerShell 7.4.0-rc.1
 - v2.2.6 shipped in PowerShell 7.3.0
@@ -29,7 +29,33 @@ Windows PowerShell 5.1.
 
 ## Release Notes
 
-### v2.4.0-beta1 - 2025-02-28
+### v2.4.3-beta3 - 2025-07-23
+
+You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell
+Gallery.
+
+This release includes the following changes:
+
+- Allow accepting the current input automatically from within an OnIdle event
+  handler
+- Add VS Code tasks and debug config
+- Add bound check for the cursor top value to InvokePrompt
+- Fix typo in SamplePSReadLineProfile.ps1
+- Fix line ending and cache some reflection operations
+- Improve test reliability by making sure the PSReadLine one-time
+  initialization is done
+
+### v2.4.2-beta2 - 2025-04-16
+
+You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell
+Gallery.
+
+This release includes the following changes:
+
+- Add a private field to indicate if PSReadLine is initialized and ready
+- Use CFS for installing module and deploy box for module publish
+
+### v2.4.1-beta1 - 2025-02-28
 
 - Avoid querying for cursor position when it's not necessary
 - Handle buffer changes made by an event handler