Command

Invoke-ProjectRelease

Module PSPublishModule

Inputs

None

Outputs

PowerForge.PowerForgeReleaseResult

Executes a PowerShell-authored project release object through the unified PowerForge release engine.

Syntax

Invoke-ProjectRelease [-ChecksumsPath <String>] [-ExitCode] [-Frameworks <String[]>] [-InstallerProperty <String[]>] [-KeepSymbols] [-ManifestJsonPath <String>] [-OutputRoot <String>] [-Plan] -Project <ConfigurationProject> [-PublishToolGitHub] [-ReleaseVersion <String>] [-Runtimes <String[]>] [-Sign] [-SignCsp <String>] [-SignDescription <String>] [-SignKeyContainer <String>] [-SignOnFailure <Warn|Fail|Skip>] [-SignOnMissingTool <Warn|Fail|Skip>] [-SignProfile <String>] [-SignSubjectName <String>] [-SignThumbprint <String>] [-SignTimestampUrl <String>] [-SignToolPath <String>] [-SignUrl <String>] [-SkipBuild] [-SkipReleaseChecksums] [-SkipRestore] [-SkipToolOutput <Tool|Portable|Installer|Store>] [-SkipWingetSubmit] [-SkipWorkspaceValidation] [-StageRoot <String>] [-Styles <DotNetPublishStyle[]>] [-SubmitWinget] [-Target <String[]>] [-ToolOutput <Tool|Portable|Installer|Store>] [-Validate] [-WingetAllowInteractiveAuthentication] [-WingetOpenBrowser] [-WingetPullRequestTitle <String>] [-WingetReplace] [-WingetReplaceVersion <String>] [-WingetSubmitMode <Manifest|Update>] [-WingetTimeoutSeconds <Int32>] [-WingetTokenEnvName <String>] [-WingetTokenFilePath <String>] [-WingetToolPath <String>] [-WorkspaceConfigPath <String>] [-WorkspaceDisableFeature <String[]>] [-WorkspaceEnableFeature <String[]>] [-WorkspaceProfile <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

EXAMPLE 1

Invoke-ProjectRelease -Project 'Value'

Parameters

-ChecksumsPath String optional: Optional release checksums output path override.
-ExitCode SwitchParameter optional: Sets host exit code: 0 on success, 1 on failure.
-Frameworks String[] optionalaliases: Framework: Optional framework filter.
-InstallerProperty String[] optional: Optional installer MSBuild property overrides in Name=Value form.
-KeepSymbols SwitchParameter optional: Keeps symbol files for tool/app artefacts.
-ManifestJsonPath String optional: Optional release manifest output path override.
-OutputRoot String optional: Optional output root override for tool/app assets.
-Plan SwitchParameter optional: Builds the release plan without executing steps.
-Project ConfigurationProject required: PowerShell-authored project/release object.
-PublishToolGitHub SwitchParameter optional: Enables tool/app GitHub release publishing for this run.
-ReleaseVersion String optional: Exact x.y.z version override for the tool-only release.
-Runtimes String[] optionalaliases: Rid, Runtime: Optional runtime filter.
-Sign SwitchParameter optional: Enables signing for tool/app outputs when supported by the project object.
-SignCsp String optional: Optional signing CSP override.
-SignDescription String optional: Optional signing description override.
-SignKeyContainer String optional: Optional signing key container override.
-SignOnFailure DotNetPublishPolicyMode optional: Optional policy when signing fails.; Possible values: Warn, Fail, Skip
-SignOnMissingTool DotNetPublishPolicyMode optional: Optional policy when the configured signing tool is missing.; Possible values: Warn, Fail, Skip
-SignProfile String optional: Optional signing profile override.
-SignSubjectName String optional: Optional signing certificate subject name override.
-SignThumbprint String optional: Optional signing thumbprint override.
-SignTimestampUrl String optional: Optional signing timestamp URL override.
-SignToolPath String optional: Optional signing tool path override.
-SignUrl String optional: Optional signing URL override.
-SkipBuild SwitchParameter optional: Disables build operations for the tool/app publish flow.
-SkipReleaseChecksums SwitchParameter optional: Skips top-level release checksums generation.
-SkipRestore SwitchParameter optional: Disables restore operations for the tool/app publish flow.
-SkipToolOutput String[] optional: Optional tool/app output exclusion.; Possible values: Tool, Portable, Installer, Store
-SkipWingetSubmit SwitchParameter optional: Disables Winget submission even when enabled by project configuration.
-SkipWorkspaceValidation SwitchParameter optional: Skips workspace validation defined by the project object.
-StageRoot String optional: Optional staged release root override.
-Styles DotNetPublishStyle[] optionalaliases: Style: Optional publish style filter.; Possible values: Portable, PortableCompat, PortableSize, SelfContained, FrameworkDependent, AotSpeed, AotSize
-SubmitWinget SwitchParameter optional: Submits generated Winget manifests with wingetcreate after release assets are available.
-Target String[] optionalaliases: Targets: Optional target-name filter.
-ToolOutput String[] optional: Optional tool/app output selection.; Possible values: Tool, Portable, Installer, Store
-Validate SwitchParameter optional: Validates configuration through plan-only execution.
-WingetAllowInteractiveAuthentication SwitchParameter optional: Allows wingetcreate to prompt for GitHub authentication when no token is resolved.
-WingetOpenBrowser SwitchParameter optional: Allows wingetcreate to open the submitted pull request in a browser.
-WingetPullRequestTitle String optional: Pull request title template passed to wingetcreate.
-WingetReplace SwitchParameter optional: Enables wingetcreate replacement mode.
-WingetReplaceVersion String optional: Optional version passed with wingetcreate replacement mode.
-WingetSubmitMode String optional: Winget submission mode used by wingetcreate.; Possible values: Manifest, Update
-WingetTimeoutSeconds Int32 optional: Timeout in seconds for each wingetcreate invocation.
-WingetTokenEnvName String optional: Environment variable containing the GitHub token for wingetcreate.
-WingetTokenFilePath String optional: File containing the GitHub token for wingetcreate.
-WingetToolPath String optional: Optional wingetcreate executable path.
-WorkspaceConfigPath String optional: Optional workspace validation config override.
-WorkspaceDisableFeature String[] optional: Optional workspace feature disable list override.
-WorkspaceEnableFeature String[] optional: Optional workspace feature enable list override.
-WorkspaceProfile String optional: Optional workspace validation profile override.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.