Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
- name: Install Prerequisites
run: .\build\psf-prerequisites.ps1
shell: powershell
- name: Install Prerequisites
- name: Compile Help
run: .\build\vsts-help.ps1
shell: powershell
- name: Validate
Expand Down
2 changes: 1 addition & 1 deletion PSFramework/PSFramework.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
RootModule = 'PSFramework.psm1'

# Version number of this module.
ModuleVersion = '1.13.419'
ModuleVersion = '1.13.425'

# ID used to uniquely identify this module
GUID = '8028b914-132b-431f-baa9-94a6952f21ff'
Expand Down
Binary file modified PSFramework/bin/PSFramework.dll
Binary file not shown.
Binary file modified PSFramework/bin/PSFramework.pdb
Binary file not shown.
145 changes: 137 additions & 8 deletions PSFramework/bin/PSFramework.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4590,6 +4590,11 @@
Whether the console messages should be written with only one color, rather than respecting color tags
</summary>
</member>
<member name="F:PSFramework.Message.MessageHost.OldColor">
<summary>
Whether the console messages should be written with multiple Write-Hosts, rather than one using ANSI sequences
</summary>
</member>
<member name="F:PSFramework.Message.MessageHost.TimeFormat">
<summary>
The format used in messages written on screen
Expand Down Expand Up @@ -8478,6 +8483,11 @@
Class that contains the logic necessary to manage a unique runspace
</summary>
</member>
<member name="P:PSFramework.Runspace.RunspaceContainer.Generation">
<summary>
The Generation of the Managed Runspace, determining the featureset used by it.
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceContainer.Name">
<summary>
The name of the runspace.
Expand All @@ -8488,17 +8498,64 @@
The Guid of the running Runspace
</summary>
</member>
<member name="P:PSFramework.Runspace.RunspaceContainer.Script">
<summary>
The Code that will be used when running the runspace.
</summary>
</member>
<member name="M:PSFramework.Runspace.RunspaceContainer.SetScript(System.Management.Automation.ScriptBlock)">
<summary>
Sets the script to execute in the runspace. Will NOT take immediate effect. Only after restarting the runspace will it be used.
</summary>
<param name="Script">The scriptblock to execute</param>
</member>
<member name="M:PSFramework.Runspace.RunspaceContainer.#ctor(System.String,System.Management.Automation.ScriptBlock)">
<summary>
Creates a new Gen 1 runspace container with the basic information needed
</summary>
<param name="Name">The name of the Runspace</param>
<param name="Script">The code using the runspace logic</param>
</member>
<member name="P:PSFramework.Runspace.RunspaceContainer.Begin">
<summary>
The initialization code of the runspace, executed in the global scope.
</summary>
</member>
<member name="P:PSFramework.Runspace.RunspaceContainer.Process">
<summary>
The execution code of the runspace, will be called repeatedly over the time of the runspace.
</summary>
</member>
<member name="P:PSFramework.Runspace.RunspaceContainer.End">
<summary>
The finalization code of the runspace, will be called once when closing out the runspace.
</summary>
</member>
<member name="M:PSFramework.Runspace.RunspaceContainer.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock)">
<summary>
Creates a new Gen 2 runspace container with the basic information needed
</summary>
<param name="Name">The name of the Runspace</param>
<param name="Begin">The initialization code of the runspace, executed in the global scope.</param>
<param name="Process">The execution code of the runspace, will be called repeatedly over the time of the runspace.</param>
<param name="End">The finalization code of the runspace, will be called once when closing out the runspace.</param>
</member>
<member name="M:PSFramework.Runspace.RunspaceContainer.GetRuntime">
<summary>
Initialize a runtime reference for the current managed runspace
</summary>
<returns>A Runtime reference, including the code for all three phases of a Gen 2 Managed Runspace</returns>
</member>
<member name="P:PSFramework.Runspace.RunspaceContainer.State">
<summary>
The state the runspace currently is in.
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceContainer.Errors">
<summary>
The last 50 errors that happened in the runspace
</summary>
</member>
<member name="M:PSFramework.Runspace.RunspaceContainer.Start">
<summary>
Starts the Runspace.
Expand All @@ -8525,33 +8582,54 @@
Signals the registered runspace has stopped execution
</summary>
</member>
<member name="M:PSFramework.Runspace.RunspaceContainer.#ctor(System.String,System.Management.Automation.ScriptBlock)">
<member name="M:PSFramework.Runspace.RunspaceContainer.SignalFailed">
<summary>
Creates a new runspace container with the basic information needed
Signals the registered runspace has failed badly and error logs should be checked.
</summary>
<param name="Name">The name of the Runspace</param>
<param name="Script">The code using the runspace logic</param>
</member>
<member name="T:PSFramework.Runspace.RunspaceHost">
<summary>
Provides hosting for all registered runspaces
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceHost.StopTimeoutSeconds">
<member name="P:PSFramework.Runspace.RunspaceHost.RbvCleanupInterval">
<summary>
The number of seconds before a Stop command is interrupted and instead the runspace is gracelessly shut down.
The interval (in milliseonds) in which Runspace-Bound Values will be leaned up
</summary>
</member>
<member name="P:PSFramework.Runspace.RunspaceHost.RbvCleanupInterval">
<member name="F:PSFramework.Runspace.RunspaceHost.StopTimeoutSeconds">
<summary>
The interval (in milliseonds) in which Runspace-Bound Values will be leaned up
The number of seconds before a Stop command is interrupted and instead the runspace is gracelessly shut down.
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceHost.Runspaces">
<summary>
The dictionary containing the definitive list of unique Runspace
</summary>
</member>
<member name="M:PSFramework.Runspace.RunspaceHost.SetManagedRunspace(System.String,System.Management.Automation.ScriptBlock)">
<summary>
Define the managed runspace or update its code as a Gen 1 Runspace
</summary>
<param name="Name">The name of the managed runspace</param>
<param name="Code">The code implementing the managed runspace</param>
<returns>Whether the runspace was created new (true) or merely updated (false)</returns>
</member>
<member name="M:PSFramework.Runspace.RunspaceHost.SetManagedRunspace(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock)">
<summary>
Define the managed runspace or update its code as a Gen 2 Runspace
</summary>
<param name="Name">The name of the managed runspace</param>
<param name="Begin">The Begin stage of the managed runspace</param>
<param name="Process">The Process stage of the managed runspace</param>
<param name="End">The End stage of the managed runspace</param>
<returns>Whether the runspace was created new (true) or merely updated (false)</returns>
</member>
<member name="P:PSFramework.Runspace.RunspaceHost.ManagedRunspaceCodeGen2">
<summary>
The Code to use for Gen 2 Managed Runspaces
</summary>
</member>
<member name="P:PSFramework.Runspace.RunspaceHost._RunspaceBoundValues">
<summary>
List of all runspace bound values in use
Expand Down Expand Up @@ -8708,6 +8786,47 @@
<param name="Output">The output result of the task</param>
<param name="Streams">The streams the task sent</param>
</member>
<member name="T:PSFramework.Runspace.RunspaceRuntime">
<summary>
Wrapper around the execution stages of a Generation 2 Managed Runspace
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceRuntime.Begin">
<summary>
Begin phase of the Managed Runspace
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceRuntime.Process">
<summary>
Process phase of the Managed Runspace
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceRuntime.End">
<summary>
End phase of the Managed Runspace
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceRuntime.Errors">
<summary>
Access to the error queue of the managed runspace
</summary>
</member>
<member name="F:PSFramework.Runspace.RunspaceRuntime.Workload">
<summary>
The actual runspace container with the original task.
MAY BE MODIFIED after launch, should not be used for critical lifestate data.
</summary>
</member>
<member name="M:PSFramework.Runspace.RunspaceRuntime.#ctor(System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,PSFramework.Utility.LimitedConcurrentQueue{System.Management.Automation.ErrorRecord},PSFramework.Runspace.RunspaceContainer)">
<summary>
Create a new Managed Runspace Runtime wrapper
</summary>
<param name="Begin">Begin phase of the Managed Runspace</param>
<param name="Process">Process phase of the Managed Runspace</param>
<param name="End">End phase of the Managed Runspace</param>
<param name="Errors">Access to the error queue of the managed runspace</param>
<param name="Workload">The actual runspace container with the original task.</param>
</member>
<member name="T:PSFramework.Runspace.PsfRunspaceState">
<summary>
Contains the state a managed, unique runspace can be in.
Expand All @@ -8728,6 +8847,11 @@
The runspace has followed its order to stop and is currently disabled
</summary>
</member>
<member name="F:PSFramework.Runspace.PsfRunspaceState.Failed">
<summary>
The runspace crashed and burned. It is also stopped without fracefully closing out, check the Errors property.
</summary>
</member>
<member name="T:PSFramework.Runspace.RunspaceTask">
<summary>
An individual task executed in the runspace pool of its hosting RunspaceWrapper
Expand Down Expand Up @@ -9638,6 +9762,11 @@
The task code to execute
</summary>
</member>
<member name="F:PSFramework.TaskEngine.PsfTask.ArgumentList">
<summary>
Arguments to provide to the task code
</summary>
</member>
<member name="P:PSFramework.TaskEngine.PsfTask.IsDue">
<summary>
Whether the task is due and should be executed
Expand Down
9 changes: 9 additions & 0 deletions PSFramework/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# CHANGELOG

## 1.13.425 (2026-01-07)

- New: Configuration `PSFramework.Message.Style.OldColor` - reverts update to message printing, disabling use of ANSI codes for colors
- Upd: Register-PSFRunspace - Significantly reworked Managed Runspaces for greater ease of use.
- Upd: Register-PSFTaskEngineTask - Added `-ArgumentList` parameter to enable including data with Task
- Fix: Write-PSFMessage - Messages to host get jumbled when logging from parallel tasks (#707)
- Fix: Register-PSFRunspace - Closed Constrained Language Mode escape
- Fix: Register-PSFRunspace - Closed edge-case concurrency issue that was extremely unlikely to ever matter.

## 1.13.419 (2025-11-24)

- Fix: Get-PSFRunspaceLock - Fails to create new runspace lock.
Expand Down
20 changes: 0 additions & 20 deletions PSFramework/en-us/about_psf_runspace.help.txt

This file was deleted.

Loading