API Reference
Command
New-ConfigurationPackageBuild
Creates inline .NET/NuGet package build configuration from the module-build DSL.
Remarks
This cmdlet mirrors the repository package build settings normally authored in project.build.json, allowing Build-Module { } to remain the primary authoring surface for combined module and package publishing.
Examples
EXAMPLE 1
New-ConfigurationPackageBuild -GitHubAccessTokenFilePath 'C:\Path'
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-ConfigurationPackageBuild [-AlignPackageVersions] [-Build] [-BuildBeforeModule] [-CertificateStore <String>] [-CertificateThumbprint <String>] [-CleanStaging] [-Configuration <String>] [-CreateReleaseZip] [-Enabled] [-ExcludeDirectories <String[]>] [-ExcludeProjects <String[]>] [-ExpectedVersion <String>] [-ExpectedVersionMap <IDictionary>] [-ExpectedVersionMapAsInclude] [-ExpectedVersionMapUseWildcards] [-GitHubAccessToken <String>] [-GitHubAccessTokenEnvName <String>] [-GitHubAccessTokenFilePath <String>] [-GitHubGenerateReleaseNotes] [-GitHubIncludeProjectNameInTag] [-GitHubIsPreRelease] [-GitHubPackagesOwner <String>] [-GitHubPrimaryProject <String>] [-GitHubReleaseMode <String>] [-GitHubReleaseName <String>] [-GitHubRepositoryName <String>] [-GitHubTagConflictPolicy <String>] [-GitHubTagName <String>] [-GitHubTagTemplate <String>] [-GitHubUsername <String>] [-IncludePrerelease] [-IncludeProjects <String[]>] [-IncludeSymbols] [-Name <String>] [-NugetCredentialSecret <String>] [-NugetCredentialSecretEnvName <String>] [-NugetCredentialSecretFilePath <String>] [-NugetCredentialUserName <String>] [-NugetSource <String[]>] [-Options <IDictionary>] [-OutputPath <String>] [-OverwriteSignedAssemblies] [-OverwriteSignedPackages] [-PackStrategy <String>] [-PlanOnly] [-PlanOutputPath <String>] [-ProvideLocalNuGetFeed] [-PublishApiKey <String>] [-PublishApiKeyEnvName <String>] [-PublishApiKeyFilePath <String>] [-PublishFailFast] [-PublishGitHub] [-PublishNuget] [-PublishSource <String>] [-ReleaseZipOutputPath <String>] [-RootPath <String>] [-SignAssemblies] [-SignDependencyAssemblies] [-SignPackages] [-SkipDuplicate] [-StagingPath <String>] [-TimeStampServer <String>] [-UpdateVersions] [-UseAsReleaseVersionSource] [-UseGitHubPackages] [-VersionBindings <ProjectVersionBinding[]>] [-VersionTracks <IDictionary>] [<CommonParameters>]Parameter set:
All Parameter SetsParameters
- AlignPackageVersions SwitchParameter
- Align projects sharing an X-pattern to one next version based on the highest current package version in that group.
- Build SwitchParameter
- Whether package projects should be built/packed.
- BuildBeforeModule SwitchParameter
- Whether package outputs must be produced before the module lane runs.
- CertificateStore String
- Certificate store location for package signing.
- CertificateThumbprint String
- Code signing certificate thumbprint for package signing.
- CleanStaging SwitchParameter
- Whether to clean staging before the package build runs.
- Configuration String
- Build configuration, usually Release or Debug.
- CreateReleaseZip SwitchParameter
- Whether release ZIPs should be created for package projects.
- Enabled SwitchParameter
- Whether this package build lane is enabled. Defaults to true.
- ExcludeDirectories String[]
- Directory names to exclude from project discovery.
- ExcludeProjects String[]
- Project names to exclude.
- ExpectedVersion String
- Global expected package version or X-pattern.
- ExpectedVersionMap IDictionary
- Per-project expected package version map.
- ExpectedVersionMapAsInclude SwitchParameter
- When true, ExpectedVersionMap acts as an include list.
- ExpectedVersionMapUseWildcards SwitchParameter
- When true, ExpectedVersionMap keys support wildcard matching.
- GitHubAccessToken String
- Inline GitHub access token. Prefer file or environment forms for automation.
- GitHubAccessTokenEnvName String
- Environment variable containing the GitHub access token.
- GitHubAccessTokenFilePath String
- Path to a file containing the GitHub access token.
- GitHubGenerateReleaseNotes SwitchParameter
- Whether GitHub should generate release notes.
- GitHubIncludeProjectNameInTag SwitchParameter
- Whether project name should be included in generated package GitHub tags. Defaults to true.
- GitHubIsPreRelease SwitchParameter
- Whether GitHub releases should be marked prerelease.
- GitHubPackagesOwner String
- GitHub user or organization that owns the GitHub Packages NuGet feed.
- GitHubPrimaryProject String
- Primary project used for single-release version resolution.
- GitHubReleaseMode String
- GitHub release mode, for example Single or PerProject.
- GitHubReleaseName String
- GitHub release name template or override.
- GitHubRepositoryName String
- GitHub repository name.
- GitHubTagConflictPolicy String
- GitHub tag conflict policy.
- GitHubTagName String
- GitHub tag name override.
- GitHubTagTemplate String
- GitHub tag template.
- GitHubUsername String
- GitHub owner/user name.
- IncludePrerelease SwitchParameter
- Whether prerelease versions can be considered during version lookup.
- IncludeProjects String[]
- Project names to include.
- IncludeSymbols SwitchParameter
- Whether portable .snupkg symbol packages should be created.
- Name String
- Optional friendly name for this package build lane.
- NugetCredentialSecret String
- NuGet version lookup credential secret.
- NugetCredentialSecretEnvName String
- Environment variable containing the NuGet version lookup credential secret.
- NugetCredentialSecretFilePath String
- Path to a file containing the NuGet version lookup credential secret.
- NugetCredentialUserName String
- NuGet version lookup credential user name.
- NugetSource String[]
- NuGet sources used for version lookup.
- Options IDictionary
- Additional project-build options for fields not yet modeled as first-class parameters.
- OutputPath String
- Package output path override.
- OverwriteSignedAssemblies SwitchParameter
- Whether existing Authenticode assembly signatures may be replaced.
- OverwriteSignedPackages SwitchParameter
- Whether existing NuGet package signatures may be replaced.
- PackStrategy String
- Pack strategy, for example PerProject or MSBuild.
- PlanOnly SwitchParameter
- Whether to produce a plan without executing package build steps.
- PlanOutputPath String
- Plan output path.
- ProvideLocalNuGetFeed SwitchParameter
- Whether package outputs should be exposed as a temporary local NuGet feed for the module lane.
- PublishApiKey String
- Inline NuGet publish API key. Prefer file or environment forms for automation.
- PublishApiKeyEnvName String
- Environment variable containing the NuGet publish API key.
- PublishApiKeyFilePath String
- Path to a file containing the NuGet publish API key.
- PublishFailFast SwitchParameter
- Whether package publishing should stop on first failure.
- PublishGitHub SwitchParameter
- Whether package GitHub release publishing should be enabled.
- PublishNuget SwitchParameter
- Whether NuGet packages should be published.
- PublishSource String
- NuGet publish source.
- ReleaseZipOutputPath String
- Release ZIP output path override.
- RootPath String
- Root path used for project discovery.
- SignAssemblies SwitchParameter
- Whether assemblies should be signed before packages are created.
- SignDependencyAssemblies SwitchParameter
- Whether copied dependency assemblies should also be signed.
- SignPackages SwitchParameter
- Whether generated NuGet packages should be signed.
- SkipDuplicate SwitchParameter
- Whether duplicate NuGet packages should be skipped during push.
- StagingPath String
- Staging root for project-build outputs.
- TimeStampServer String
- Timestamp server URL for package signing.
- UpdateVersions SwitchParameter
- Whether project/package versions should be updated.
- UseAsReleaseVersionSource SwitchParameter
- Whether the resolved package version should be used as the unified release version source.
- UseGitHubPackages SwitchParameter
- Whether GitHub Packages should be used as the NuGet version lookup and publish feed.
- VersionBindings ProjectVersionBinding[]
- Repository files whose embedded versions follow a resolved project version.
- VersionTracks IDictionary
- Shared version tracks keyed by track name.
Outputs
PowerForge.ConfigurationPackageBuildSegment