This template standardizes action and workflow documentation.
Explain what the action or workflow does.
Describe required and optional parameters.
type): Description of required parameter.type): Description of optional parameter.Map GitHub Action inputs to CLI parameters when applicable.
| Input | CLI parameter | Description |
|---|---|---|
input_name |
ParameterName |
Explanation. |
pwsh -File actions/Invoke-OSAction.ps1 -ActionName <action-name> -ArgsJson '{
"ParameterName": "value"
}'
- name: Run action
uses: owner/repo/<action-name>@v1
with:
input_name: value
0 – success