natescherer/Update PowerShell Metadata
A GitHub Action to update metadata in PowerShell modules and scripts.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Path to relative to the root of the project. Can either be a .psd1 file, a .ps1 file, or a directory. If a directory, the action will search for a .psd1 file in the root. If none are found, it will then search for a .ps1 file in the root. | yes | — |
| version | A SemVer 1.0.0 compatible version number (must be SermVer 1.0.0 due to PowerShellGet's limitations). Supports prerelease versions such as 1.0.0-alpha. | no | — |
| copyright | Copyright information. Include YYYY and it will automatically be replaced by the current year. | no | — |
| description | Description of the module/script. | no | — |
| releaseNotes | Release notes for the module/script. | no | — |
| functionsToExport | A comma-separated list of functions that should be exported from a module. Does not apply to scripts. | no | — |
| functionsToExportPath | An alternate input instead of `functionsToExport` that will scan a directory for .ps1 files and export functions matching those file names. Useful if your module design uses dot-sourcing. | no | — |
Outputs
| name | description |
|---|---|
| path | The fully-qualified path of the file that was modified by this action. |