|
1 | | -# Document-PSModule (by PSModule) |
| 1 | +# Document-PSModule |
2 | 2 |
|
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. |
17 | | - |
18 | | -## Usage |
19 | | - |
20 | | -Include this action in your workflow to automatically build and structure documentation for your PowerShell module. |
21 | | - |
22 | | -### Inputs |
23 | | - |
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 | | -| `ShowSummaryOnSuccess` | Show GitHub Step Summary even when all commands succeed. | No | `false` | |
29 | | - |
30 | | -### Secrets |
31 | | - |
32 | | -This action does not require any secrets. |
33 | | - |
34 | | -### Outputs |
35 | | - |
36 | | -This action does not have defined outputs. |
37 | | - |
38 | | -### Example |
39 | | - |
40 | | -```yaml |
41 | | -- name: Document PowerShell Module |
42 | | - uses: PSModule/Document-PSModule@v1 |
43 | | - with: |
44 | | - Name: 'MyModule' |
45 | | - WorkingDirectory: './module-directory' |
46 | | - ShowSummaryOnSuccess: true # Optional: Show summary even on success |
47 | | -``` |
| 3 | +This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). |
0 commit comments