API Reference
Command
New-ConfigurationRelease
Creates repo-level release coordination settings for a module and package build.
Remarks
Creates repo-level release coordination settings for a module and package build.
Examples
EXAMPLE 1
New-ConfigurationRelease -BuildOrder @('Value')
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.
Syntax
New-ConfigurationRelease [-BuildOrder <String[]>] [-PrimaryProject <String>] [-PublishOrder <String[]>] [-ResumeIncompleteRelease] [-StageRoot <String>] [-SynchronizeModuleVersion] [-Version <String>] [-VersionSource <Module|ProjectBuild|PackageBuild|Manual>] [<CommonParameters>]Parameter set:
All Parameter SetsParameters
- BuildOrder String[]
- Preferred build order for high-level release lanes.
- PrimaryProject String
- Primary package/project used when the version source is a package/project build. Required by SynchronizeModuleVersion to identify the package coordinated with module history.
- PublishOrder String[]
- Preferred publish order for destinations such as NuGet, PowerShellGallery, and GitHub.
- ResumeIncompleteRelease SwitchParameter
- Explicitly resumes a compatible incomplete synchronized release checkpoint. Without this switch, an older checkpoint is archived and the invocation starts a fresh release.
- StageRoot String
- Staged release root where upload-ready assets should be copied.
- SynchronizeModuleVersion SwitchParameter
- Coordinates the module and selected primary package on one version. This is enabled automatically when VersionSource is ProjectBuild or PackageBuild and PrimaryProject is configured. The next available module version becomes a floor for the primary package; a higher numeric package version still wins. At the same numeric version, a stable X-pattern candidate does not erase the configured module prerelease; explicit prerelease versions retain normal semantic-version ordering. PrimaryProject is required, and exactly one selected lane must run before the module and use UseAsReleaseVersionSource. Package groups using AlignPackageVersions are raised together. Publish runs persist a credential-free checkpoint for optional recovery. A normal invocation archives an incomplete checkpoint and starts fresh; use ResumeIncompleteRelease to retain the exact versions and skip destinations that already completed.
- Version String
- Explicit release version used when VersionSource is Manual.
- VersionSource ReleaseVersionSource
- Source used to resolve the coordinated release version.
- Possible values:
Module,ProjectBuild,PackageBuild,Manual
Outputs
PowerForge.ConfigurationReleaseSegment