API Reference
Step-Version
Steps a version based on an expected version pattern (supports the legacy X placeholder).
Remarks
This cmdlet supports two common workflows: When -ExpectedVersion contains an X placeholder (e.g. 1.2.X), the cmdlet resolves the next patch version. When an exact version is provided, it is returned as-is.
Examples
Step a version using a local module manifest
PS>
Step-Version -ExpectedVersion '1.0.X' -LocalPSD1 'C:\Git\MyModule\MyModule.psd1'
Reads the current version from the PSD1 and returns the next patch version.
Return the full step result object
PS>
Step-Version -ExpectedVersion '1.0.X' -LocalPSD1 '.\MyModule.psd1' -Advanced
Returns a structured object that includes whether auto-versioning was used.
Step based on the latest published module
PS>
Step-Version -ExpectedVersion '1.0.X' -Module 'MyModule'
Resolves the next patch version by looking up the current version of the module.
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
Step-Version [-Advanced] -ExpectedVersion <String> [-LocalPSD1 <String>] [-Module <String>] [<CommonParameters>]
#
All Parameter SetsParameters
- Advanced SwitchParameter
- When set, returns a typed result instead of only the version string.
- ExpectedVersion String
- Expected version (exact or pattern like 0.1.X).
- LocalPSD1 String
- Optional local PSD1 path used to resolve current version.
- Module String
- Optional module name used to resolve current version from PSGallery.
Outputs
System.String PowerForge.ModuleVersionStepResult