File tree Expand file tree Collapse file tree 2 files changed +31
-18
lines changed
Expand file tree Collapse file tree 2 files changed +31
-18
lines changed Original file line number Diff line number Diff line change 1- # Template-Action
1+ # Document-PSModule (by PSModule)
22
3- A template repository for GitHub Actions
3+ A GitHub Action that automates the generation of documentation for PowerShell modules using markdown help files.
4+
5+ This GitHub Action is a part of the [ PSModule framework] ( https://github.com/PSModule ) . It is recommended to use the
6+ [ Process-PSModule workflow] ( https://github.com/PSModule/Process-PSModule ) to automate the whole process of managing the PowerShell module.
7+
8+ ## Details
9+
10+ This action:
11+ - Installs necessary modules, including ` platyPS ` for documentation generation.
12+ - Loads helper scripts required by the documentation process.
13+ - Generates markdown documentation from PowerShell module files.
14+ - Ensures markdown documentation is properly formatted, with correctly tagged PowerShell code blocks.
15+ - Adjusts markdown file paths to mirror the structure of the source PowerShell module files.
16+ - Outputs organized markdown documentation suitable for publishing or distribution.
417
518## Usage
619
20+ Include this action in your workflow to automatically build and structure documentation for your PowerShell module.
21+
722### Inputs
823
24+ | Input | Description | Required | Default |
25+ | --------------------| -----------------------------------------------| ----------| -------------|
26+ | ` Name ` | Name of the module to document. | No | <Repo name > |
27+ | ` WorkingDirectory ` | Directory from which the script will execute. | No | ` . ` |
28+
929### Secrets
1030
31+ This action does not require any secrets.
32+
1133### Outputs
1234
35+ This action does not have defined outputs.
36+
1337### Example
1438
1539``` yaml
16- Example here
40+ - name : Document PowerShell Module
41+ uses : PSModule/Document-PSModule@v1
42+ with :
43+ Name : ' MyModule'
44+ WorkingDirectory : ' ./module-directory'
1745` ` `
Original file line number Diff line number Diff line change 99 Name :
1010 description : Name of the module to process.
1111 required : false
12- Debug :
13- description : Enable debug output.
14- required : false
15- default : ' false'
16- Verbose :
17- description : Enable verbose output.
18- required : false
19- default : ' false'
20- Version :
21- description : Specifies the version of the GitHub module to be installed. The value must be an exact version.
22- required : false
23- Prerelease :
24- description : Allow prerelease versions if available.
25- required : false
26- default : ' false'
2712 WorkingDirectory :
2813 description : The working directory where the script will run from.
2914 required : false
You can’t perform that action at this time.
0 commit comments