From b541c378f4d3ba5f9d66af1b1c56901808957b39 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 15 Oct 2025 13:09:31 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Simplify=20README=20a?= =?UTF-8?q?nd=20action.yml=20by=20removing=20unnecessary=20details?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 48 ++---------------------------------------------- action.yml | 5 +---- 2 files changed, 3 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 57aea3f..ac76518 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,3 @@ -# Document-PSModule (by PSModule) +# Document-PSModule -A GitHub Action that automates the generation of documentation for PowerShell modules using Markdown help files. - -This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). It is recommended to use the -[Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate the whole process of managing the PowerShell module. - -## Details - -This action: -- Installs necessary modules, including `platyPS` for documentation generation. -- Loads helper scripts required by the documentation process. -- Generates Markdown documentation from PowerShell module files. -- Ensures Markdown documentation is properly formatted, with correctly tagged PowerShell code blocks. -- Adjusts Markdown file paths to mirror the structure of the source PowerShell module files. -- Outputs organized Markdown documentation suitable for publishing or distribution. - -## Usage - -Include this action in your workflow to automatically build and structure documentation for your PowerShell module. - -### Inputs - -| Input | Description | Required | Default | -|--------------------|-----------------------------------------------|----------|-------------| -| `Name` | Name of the module to document. | No | | -| `WorkingDirectory` | Directory from which the script will execute. | No | `.` | -| `ShowSummaryOnSuccess` | Show GitHub Step Summary even when all commands succeed. | No | `false` | - -### Secrets - -This action does not require any secrets. - -### Outputs - -This action does not have defined outputs. - -### Example - -```yaml -- name: Document PowerShell Module - uses: PSModule/Document-PSModule@v1 - with: - Name: 'MyModule' - WorkingDirectory: './module-directory' - ShowSummaryOnSuccess: true # Optional: Show summary even on success -``` +This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). diff --git a/action.yml b/action.yml index 1b3d4fd..a648223 100644 --- a/action.yml +++ b/action.yml @@ -1,9 +1,6 @@ -name: Document-PSModule (by PSModule) +name: Document-PSModule description: Build documentation for a PowerShell module. author: PSModule -branding: - icon: package - color: gray-dark inputs: Name: