Skip to content

Releases: PSModule/Template-PSModule

0.0.12

Choose a tag to compare

@github-actions github-actions released this 25 Jul 16:32
63b41ad

fix: use blank-line description format for .INPUTS and .OUTPUTS (#34)

What

Updates the scaffold function to use the blank-line description format for .INPUTS and .OUTPUTS comment-based help:

.INPUTS
None

You cannot pipe objects to this function.

.OUTPUTS
System.String

A greeting string for the given name.

Why

The type-name-only format works but gives callers no useful context. Descriptions are required — they should say what is actually piped in or returned, not just repeat the type name.

This PR is also a CI verification: confirming that the blank-line format (type → blank line → description paragraph) passes PlatyPS + markdownlint in Build-Docs. Previous attempts failed with:

  • Single-line System.String. Description. → MD026 (trailing . in heading)
  • 4-space-indented description → MD046 (indented code block)

The blank-line format should produce a clean ### type heading with the description as body text below — no linting violations.

Informs

  • MSXOrg/docs#69 — if CI passes here, #69 should be closed and the docs updated to require descriptions in this format.

0.0.11

Choose a tag to compare

@github-actions github-actions released this 25 Jul 16:19
016ca1d

feat: establish guidance chain (AGENTS.md, CONTRIBUTING.md, copilot-instructions.md, slim README) (#32)

Summary

Establishes the local guidance and onboarding chain for agents and contributors before any template slimming work happens.

This is PR 1 of a planned multi-PR simplification for Template-PSModule.

Changes

  • AGENTS.md — OKF-style pointer file with the discovery order: local README → local CONTRIBUTING → .github/PSModule.yml → PSModule/docs → MSXOrg/docs. Points agents to the canonical guidance in PSModule/docs and MSXOrg/docs. Does not duplicate any process knowledge.
  • CLAUDE.md — Claude Code entry point that imports AGENTS.md so Claude reads the same instructions.
  • .github/copilot-instructions.md — VS Code / GitHub Copilot entry point that points to AGENTS.md.
  • CONTRIBUTING.md — Self-contained contribution workflow for this template repository. Covers branching, PR flow, issue format, and code standards with links to the canonical docs.
  • README.md — Slimmed to describe the template's purpose and the post-creation checklist. Removes the filled-in module example content that was misleading for a template repo. Points contributors and agents to the right places.

What this does NOT do

This PR does not perform the large repo slimming/deletion work planned for subsequent PRs.

Checklist

  • AGENTS.md follows the thin-pointer pattern from Agentic Development
  • CLAUDE.md and copilot-instructions.md point back to AGENTS.md, no duplication
  • CONTRIBUTING.md is self-contained and references canonical docs
  • README.md describes template purpose only
  • Discovery order matches the coordinated plan

0.0.10

Choose a tag to compare

@github-actions github-actions released this 11 Jul 16:00
a57f0c1

🩹 [Patch]: Refactor TestData JSON formatting in Process-PSModule.yml (#28)

This pull request updates the way test environment variables are passed to the workflow in .github/workflows/Process-PSModule.yml. The main change is to the formatting and encoding of the TestData field, specifically for how variables are referenced.

Workflow variable handling:

  • Changed the TestData field to reference TEST_VARIABLE using "${{ vars.TEST_VARIABLE }}" instead of toJSON(vars.TEST_VARIABLE), simplifying the value assignment and making it consistent with secret referencing.
  • Reformatted the TestData JSON for improved readability by expanding it to multiple lines.

0.0.9

Choose a tag to compare

@github-actions github-actions released this 11 Jul 12:32
ab2632b

⚙️ [Maintenance]: Showcase both docs section landing-page conventions (index.md + folder-named) (#27)

Two example command groups demonstrate both supported ways to give a command group its documentation section landing page. IndexSection provides its landing page as index.md; NamedSection provides its landing page as a file named after the folder (NamedSection.md). Document-PSModule renders either overview page as the group's section landing page, so each group appears at Functions/<Group>/ in the navigation of the published GitHub Pages site.

New: Two command groups showcasing both landing-page conventions

  • IndexSection/ — landing page from index.md, with Get-IndexSectionTest.
  • NamedSection/ — landing page from the folder-named NamedSection.md, with Get-NamedSectionTest.

Each renders as its group's section landing page (Functions/IndexSection/ and Functions/NamedSection/) in the docs navigation.

Technical Details

  • Adds src/functions/public/IndexSection/{index.md, Get-IndexSectionTest.ps1} and src/functions/public/NamedSection/{NamedSection.md, Get-NamedSectionTest.ps1}; both functions mirror the existing *-PSModuleTest shape and return Hello, <Name>!.
  • Adds It blocks for Get-IndexSectionTest and Get-NamedSectionTest in tests/PSModuleTest.Tests.ps1.
  • Generated docs place each group overview at <Group>/index.md; the rendered site exposes Functions/IndexSection/index.html and Functions/NamedSection/index.html.
  • Bumps the Process-PSModule pin (v6.1.1v6.1.2) to adopt the fix that exposes caller-provided TestData to the module test jobs, keeping the module test matrix green.

v0.0.8

Choose a tag to compare

@github-actions github-actions released this 22 Jan 14:53
7898774

🩹[Patch]: Update dependabot schedule and pin workflow to SHA (#14)

Dependabot now checks for updates daily with a 7-day cooldown period, reducing noise while maintaining timely security updates. The Process-PSModule workflow is pinned to a specific commit SHA with version comment for enhanced security and reproducibility.

Dependabot Configuration

Updated the schedule from weekly to daily with a cooldown of 7 days. This means Dependabot will check for updates daily but will wait 7 days after a new version is released before creating a PR, helping to avoid early adoption of potentially unstable releases.

schedule:
  interval: daily
cooldown:
  default-days: 7

Pinned Workflows

The reusable workflow is now pinned to a specific commit SHA with version tag comment for traceability:

Workflow Version Commit SHA
PSModule/Process-PSModule v5.4.1 be7d5dcbceec14855d325fdd34f2a7c2f05a7f57

v0.0.7

Choose a tag to compare

@github-actions github-actions released this 15 Oct 10:31
879ff6d

What's Changed

Other Changes

Full Changelog: v0.0.6...v0.0.7

v0.0.6

Choose a tag to compare

@github-actions github-actions released this 15 Oct 10:12
6f45d13

What's Changed

Other Changes

Full Changelog: v0.0.5...v0.0.6

v0.0.5

Choose a tag to compare

@github-actions github-actions released this 12 Oct 12:02
09d5e70

What's Changed

Other Changes

Full Changelog: v0.0.4...v0.0.5

v0.0.4

Choose a tag to compare

@github-actions github-actions released this 06 Oct 13:17
10513c5

What's Changed

Other Changes

Full Changelog: v0.0.3...v0.0.4

v0.0.3

Choose a tag to compare

@github-actions github-actions released this 03 Oct 20:51
f93df08

What's Changed

Other Changes

Full Changelog: v0.0.2...v0.0.3