Skip to content

Releases: PSModule/Document-PSModule

v1.0.14

22 Jan 11:47
51affc5

Choose a tag to compare

🩹 [Patch]: Update GitHub Actions to latest versions in Action-Test workflow (#38)

Updates the GitHub Actions used in the Action-Test workflow to their latest versions, ensuring compatibility with Node.js 24 runtime and incorporating the latest bugfixes and dependency updates.

Updated Actions

Action Old Version New Version
actions/upload-artifact v4.6.2 v6.0.0
super-linter/super-linter/slim v8.2.1 v8.3.2

Notable Changes

actions/upload-artifact v6.0.0

  • Now runs on Node.js 24 (runs.using: node24)
  • Requires a minimum Actions Runner version of 2.327.1
  • If using self-hosted runners, ensure they are updated before merging

super-linter v8.3.2

  • Includes bugfixes for file array handling
  • Contains various dependency updates since v8.2.1

v1.0.13

22 Jan 11:37
57e85ec

Choose a tag to compare

🩹[Patch]: Update GitHub Actions security and linting configuration (#36)

This update improves the security posture of GitHub Actions workflows by addressing zizmor linting warnings. All action references are now pinned to specific commit hashes, permissions follow the principle of least privilege, and insecure workflow triggers have been replaced with safer alternatives.

Security improvements

Pinned action references

All GitHub Actions are now pinned to specific commit SHA hashes instead of mutable tags, preventing supply chain attacks:

  • actions/checkoutde0fac2e4500dabe0009e67214ff5f5447ce83dd (v6.0.2)
  • actions/upload-artifactea165f8d65b6e75b540449e92b4886f43607fa02 (v4.6.2)
  • super-linter/super-linterd5b0a2ab116623730dd094f15ddc1b6b25bf7b99 (v8.3.2)
  • super-linter/super-linter/slim2bdd90ed3262e023ac84bf8fe35dc480721fc1f2 (v8.2.1)
  • PSModule/Auto-Releaseeabd533035e2cb9822160f26f2eda584bd012356 (v1.9.5)
  • PSModule/Install-PSModuleHelpersd60d63e4be477d1ca0c67c6085101fb109bce8f1 (v1.0.6)

Workflow trigger security

Changed pull_request_target to pull_request in Auto-Release workflow to prevent potential code injection attacks from forked repositories.

Least privilege permissions

Moved statuses: write permission from workflow-level to job-level in Action-Test workflow, applying it only to the ActionTestDefault job that actually requires it for the linter.

Credential persistence

Added persist-credentials: false to checkout steps to prevent credential persistence in artifacts.

Linting configuration

  • Enabled VALIDATE_GITHUB_ACTIONS_ZIZMOR in Linter workflow (previously disabled)
  • Updated dependabot schedule to daily with 7-day cooldown for better dependency management

v1.0.12

26 Nov 20:16
15dc407

Choose a tag to compare

Bump actions/checkout from 5 to 6 (#31)

Bumps actions/checkout from 5 to 6.

Release notes

Sourced from actions/checkout's releases.

v6.0.0

What's Changed

Full Changelog: actions/checkout@v5.0.0...v6.0.0

v6-beta

What's Changed

Updated persist-credentials to store the credentials under $RUNNER_TEMP instead of directly in the local git config.

This requires a minimum Actions Runner version of v2.329.0 to access the persisted credentials for Docker container action scenarios.

v5.0.1

What's Changed

Full Changelog: actions/checkout@v5...v5.0.1

Changelog

Sourced from actions/checkout's changelog.

Changelog

V6.0.0

V5.0.1

V5.0.0

V4.3.1

V4.3.0

v4.2.2

v4.2.1

v4.2.0

v4.1.7

v4.1.6

v4.1.5

... (truncated)

Commits

[Dependabot compatibility score](https://docs.github.com/en/github/managing-security-vulnerabilities/about-d...

Read more

v1.0.11

28 Oct 23:40
7e50d9f

Choose a tag to compare

Bump super-linter/super-linter from 8.1.0 to 8.2.1 (#29)

Bumps super-linter/super-linter from 8.1.0 to 8.2.1.

Release notes

Sourced from super-linter/super-linter's releases.

v8.2.1

8.2.1 (2025-10-15)

🐛 Bugfixes

⬆️ Dependency updates

  • docker: bump the docker group with 2 updates (#7100) (28c5681)
  • npm: bump eslint from 9.36.0 to 9.37.0 in /dependencies (#7102) (cf6cb1e)
  • npm: bump renovate from 41.132.2 to 41.136.0 in /dependencies (#7107) (495692f)
  • npm: bump the eslint-plugins-configs group across 1 directory with 2 updates (#7101) (b3a735d)
  • npm: bump the npm group across 1 directory with 4 updates (#7108) (ce227b3)
  • npm: bump typescript (#7109) (deba11c)
  • python: bump the pip group across 1 directory with 7 updates (#7106) (7c02a56)

🧰 Maintenance

v8.2.0

8.2.0 (2025-09-30)

🚀 Features

🐛 Bugfixes

... (truncated)

Commits
  • 2bdd90e chore(main): release 8.2.1 (#7094)
  • 51e00dd chore: use powershell from dotnet sdk image (#7141)
  • 2e6ad3d chore: update rack to 3.2.3 (#7136)
  • 7508f4c fix: validate DEFAULT_BRANCH when using find (#7119)
  • cf6cb1e deps(npm): bump eslint from 9.36.0 to 9.37.0 in /dependencies (#7102)
  • 495692f deps(npm): bump renovate from 41.132.2 to 41.136.0 in /dependencies (
Read more

v1.0.10

15 Oct 11:21
84a3e4d

Choose a tag to compare

🩹 [Patch]: Move documentation and link to Process-PSModule (#28)

Description

This pull request makes minor updates to the project metadata by simplifying the display names in both the README.md and action.yml files. The changes remove branding elements and redundant text for a cleaner presentation.

  • Project naming:
    • Simplified the project name by removing redundant "(by PSModule)" from both the README.md and the action.yml files. [1] [2]
  • Metadata cleanup:
    • Removed the branding section (icon and color) from action.yml for a more streamlined configuration.
  • Documentation:
    • Shortened the project description in README.md by removing detailed usage instructions and focusing on the association with the PSModule framework.

v1.0.9

12 Oct 17:59
da2a725

Choose a tag to compare

🩹 [Patch]: Group successful and failed doc generation (#26)

Description

This pull request reorganizes the GitHub Actions workflow, improves input handling and environment variable usage in the action, and enhances the summary output for PowerShell module documentation commands. The most notable changes are the restructuring of workflow jobs to support different summary behaviors, improved input/environment variable consistency, and more detailed step summaries.

GitHub Actions workflow improvements:

  • The .github/workflows/Action-Test.yml workflow now separates artifact upload into its own UploadArtifact job, and introduces two test jobs: ActionTestDefault (without always showing summary) and ActionTestWithSummary (always shows summary on success). This allows testing both behaviors and ensures artifacts are available before running tests. [1] [2] [3]

Action input and environment variable handling:

  • The action.yml file reorders the inputs section for clarity, and environment variables passed to scripts now use a consistent DOCUMENT_PSMODULE_INPUT_* naming scheme instead of the previous GITHUB_ACTION_INPUT_*. [1] [2]
  • The scripts/main.ps1 script now accepts Name and ShowSummaryOnSuccess as parameters, defaulting to the new environment variable names, and updates how these values are handled and passed to helper scripts. [1] [2] [3]

Summary output enhancements:

  • The Build-PSModuleDocumentation.ps1 script changes the summary section to use collapsible <details> blocks for failed and succeeded commands, making the output clearer and easier to navigate in GitHub step summaries. [1] [2]

v1.0.8

12 Oct 12:28
b693138

Choose a tag to compare

🩹 [Patch]: Encode all PowerShell files using UTF8 with BOM (#25)

Description

This pull request makes a minor update to the Planets.ps1 file. The change is not functionally significant but may address encoding or formatting.

  • Added a byte order mark (BOM) at the start of Planets.ps1, which can help some editors recognize the file's encoding.

v1.0.7

11 Oct 13:49
03a9d35

Choose a tag to compare

🪲[Fix]: Fix linting issue for main (#24)

This pull request updates the Action-Test GitHub Actions workflow to improve its automation and linting capabilities. The most important changes are grouped below.

Workflow triggers:

  • The workflow will now also run on pushes to the main branch, in addition to the existing triggers (workflow_dispatch, pull_request, and schedule).

Job steps and linting improvements:

  • The step that used the PSModule/GitHub-Script@v1 action to list files and commit documentation changes has been removed, simplifying the workflow.
  • The Lint documentation step now uses super-linter/slim@v8.1.0 instead of a pinned commit from v8.2.0, and several new environment variables have been added to enable broader validation (VALIDATE_NATURAL_LANGUAGE, VALIDATE_ALL_CODEBASE, USE_FIND_ALGORITHM).

v1.0.6

07 Oct 11:01
aa32aa1

Choose a tag to compare

🩹[Patch]: Improve error handling and output error summary (#23)

Description

This pull request makes a minor improvement to error handling in the PowerShell documentation build script. Instead of writing errors as errors, it now logs them as warnings with more context when markdown help generation fails for a command.

  • Improved error reporting by changing Write-Error to Write-Warning with a descriptive message in Build-PSModuleDocumentation.ps1.

v1.0.5

07 Oct 08:17
adc0da7

Choose a tag to compare

🩹 [Patch]: Enhance error handling and summary reporting in documentation generation (#22)

Description

This pull request enhances the error handling and reporting for PowerShell module documentation generation. Now, when documentation generation fails for one or more commands, the script collects detailed error information, summarizes the failures in a GitHub Actions step summary, and fails the build with a clear message.

Improvements to error handling and reporting:

  • Introduced a $failedCommands collection to track commands that fail documentation generation, capturing their names and error details.
  • After processing all commands, if any failures occurred, the script outputs a detailed summary to the console and to the $env:GITHUB_STEP_SUMMARY file, including a markdown table of failed commands and their errors, and then fails the build with an appropriate exit code.