Tags: PSModule/Markdown
Tags
🪲 [Fix]: Fix linter settings and docs (#13) This pull request introduces updates to the linter configurations for both YAML and Markdown files. The main changes focus on customizing which linters are run and adjusting Markdown linting rules for greater flexibility. Linter configuration updates: * [`.github/PSModule.yml`](diffhunk://#diff-928165ed381f1982eb8f9746a59a2829db4abc8a28eddb8c109e12bb033ff96aR22-R31): Added a `Linter` section to the configuration, explicitly disabling several validation checks (e.g., `VALIDATE_BIOME_FORMAT`, `VALIDATE_JSCPD`, `VALIDATE_JSON_PRETTIER`, etc.) by setting their environment variables to `false`. Markdown linting rule adjustments: * [`.github/linters/.markdown-lint.yml`](diffhunk://#diff-2fd3619d2b7372123257bc21645edb90c24293e66babbc6053033a89e21bab34R16-R18): Disabled the `MD024` rule (no duplicate headings) to allow repeated headings such as INPUTS and OUTPUTS, and made a minor formatting fix to the `MD026` punctuation list.
🩹 [Patch]: Bump Process-PSModule to v5 (#12) ## Description This pull request updates the repository's CI and automation configuration, primarily focusing on consolidating and updating workflow files, cleaning up unused linter and nightly run workflows, and improving configuration management for testing and dependency updates. **Workflow and CI configuration updates:** * The `.github/workflows/Process-PSModule.yml` workflow is updated to run on both pull requests and a nightly schedule, and now uses version 5 of the upstream workflow for improved reliability and features. (`[[1]](diffhunk://#diff-b4dbaea65a86cef96799e9783b18b31e96a456d476805312f52919d45a060603L3-R6)`, `[[2]](diffhunk://#diff-b4dbaea65a86cef96799e9783b18b31e96a456d476805312f52919d45a060603L29-R30)`) * The `.github/PSModule.yml` configuration file is added to provide explicit configuration for the Process-PSModule workflow, including a code coverage target. (`[.github/PSModule.ymlR1-R21](diffhunk://#diff-928165ed381f1982eb8f9746a59a2829db4abc8a28eddb8c109e12bb033ff96aR1-R21)`) **Cleanup and removal of unused workflows:** * The `.github/workflows/Linter.yml` workflow and its associated `.github/linters/.jscpd.json` configuration file are removed, indicating a move away from the previous linter setup. (`[[1]](diffhunk://#diff-482e65806ed9e4a7320f14964764086b91fed4a28d12e4efde1776472e147e79L1-L32)`, `[[2]](diffhunk://#diff-557094e283c00b23265c1c75872f41c6b1a524a00f0d99dd68ebd22cb63bfdd6L1-L10)`) * The `.github/workflows/Nightly-Run.yml` workflow is removed, with its responsibilities likely consolidated into the updated `Process-PSModule.yml` workflow. (`[.github/workflows/Nightly-Run.ymlL1-L16](diffhunk://#diff-ae7e03d0a8740974e1848d0dc7322a8b3f3f4898b37bfd5b226dff69096bb8dfL1-L16)`) **Dependency management improvements:** * The `.github/dependabot.yml` file is updated to automatically label GitHub Actions dependency updates with `dependencies` and `github-actions`, improving visibility and tracking of these updates. (`[.github/dependabot.ymlR10-R12](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R10-R12)`)
Bump actions/checkout from 4 to 5 (#11) Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/checkout/releases">actions/checkout's releases</a>.</em></p> <blockquote> <h2>v5.0.0</h2> <h2>What's Changed</h2> <ul> <li>Update actions checkout to use node 24 by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2226">actions/checkout#2226</a></li> <li>Prepare v5.0.0 release by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2238">actions/checkout#2238</a></li> </ul> <h2>⚠️ Minimum Compatible Runner Version</h2> <p><strong>v2.327.1</strong><br /> <a href="https://github.com/actions/runner/releases/tag/v2.327.1">Release Notes</a></p> <p>Make sure your runner is updated to this version or newer to use this release.</p> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/checkout/compare/v4...v5.0.0">https://github.com/actions/checkout/compare/v4...v5.0.0</a></p> <h2>v4.3.0</h2> <h2>What's Changed</h2> <ul> <li>docs: update README.md by <a href="https://github.com/motss"><code>@motss</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1971">actions/checkout#1971</a></li> <li>Add internal repos for checking out multiple repositories by <a href="https://github.com/mouismail"><code>@mouismail</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1977">actions/checkout#1977</a></li> <li>Documentation update - add recommended permissions to Readme by <a href="https://github.com/benwells"><code>@benwells</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2043">actions/checkout#2043</a></li> <li>Adjust positioning of user email note and permissions heading by <a href="https://github.com/joshmgross"><code>@joshmgross</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2044">actions/checkout#2044</a></li> <li>Update README.md by <a href="https://github.com/nebuk89"><code>@nebuk89</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2194">actions/checkout#2194</a></li> <li>Update CODEOWNERS for actions by <a href="https://github.com/TingluoHuang"><code>@TingluoHuang</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2224">actions/checkout#2224</a></li> <li>Update package dependencies by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2236">actions/checkout#2236</a></li> <li>Prepare release v4.3.0 by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2237">actions/checkout#2237</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/motss"><code>@motss</code></a> made their first contribution in <a href="https://redirect.github.com/actions/checkout/pull/1971">actions/checkout#1971</a></li> <li><a href="https://github.com/mouismail"><code>@mouismail</code></a> made their first contribution in <a href="https://redirect.github.com/actions/checkout/pull/1977">actions/checkout#1977</a></li> <li><a href="https://github.com/benwells"><code>@benwells</code></a> made their first contribution in <a href="https://redirect.github.com/actions/checkout/pull/2043">actions/checkout#2043</a></li> <li><a href="https://github.com/nebuk89"><code>@nebuk89</code></a> made their first contribution in <a href="https://redirect.github.com/actions/checkout/pull/2194">actions/checkout#2194</a></li> <li><a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> made their first contribution in <a href="https://redirect.github.com/actions/checkout/pull/2236">actions/checkout#2236</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/checkout/compare/v4...v4.3.0">https://github.com/actions/checkout/compare/v4...v4.3.0</a></p> <h2>v4.2.2</h2> <h2>What's Changed</h2> <ul> <li><code>url-helper.ts</code> now leverages well-known environment variables by <a href="https://github.com/jww3"><code>@jww3</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1941">actions/checkout#1941</a></li> <li>Expand unit test coverage for <code>isGhes</code> by <a href="https://github.com/jww3"><code>@jww3</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1946">actions/checkout#1946</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/checkout/compare/v4.2.1...v4.2.2">https://github.com/actions/checkout/compare/v4.2.1...v4.2.2</a></p> <h2>v4.2.1</h2> <h2>What's Changed</h2> <ul> <li>Check out other refs/* by commit if provided, fall back to ref by <a href="https://github.com/orhantoy"><code>@orhantoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1924">actions/checkout#1924</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/Jcambass"><code>@Jcambass</code></a> made their first contribution in <a href="https://redirect.github.com/actions/checkout/pull/1919">actions/checkout#1919</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/checkout/compare/v4.2.0...v4.2.1">https://github.com/actions/checkout/compare/v4.2.0...v4.2.1</a></p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/actions/checkout/blob/main/CHANGELOG.md">actions/checkout's changelog</a>.</em></p> <blockquote> <h1>Changelog</h1> <h2>V5.0.0</h2> <ul> <li>Update actions checkout to use node 24 by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2226">actions/checkout#2226</a></li> </ul> <h2>V4.3.0</h2> <ul> <li>docs: update README.md by <a href="https://github.com/motss"><code>@motss</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1971">actions/checkout#1971</a></li> <li>Add internal repos for checking out multiple repositories by <a href="https://github.com/mouismail"><code>@mouismail</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1977">actions/checkout#1977</a></li> <li>Documentation update - add recommended permissions to Readme by <a href="https://github.com/benwells"><code>@benwells</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2043">actions/checkout#2043</a></li> <li>Adjust positioning of user email note and permissions heading by <a href="https://github.com/joshmgross"><code>@joshmgross</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2044">actions/checkout#2044</a></li> <li>Update README.md by <a href="https://github.com/nebuk89"><code>@nebuk89</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2194">actions/checkout#2194</a></li> <li>Update CODEOWNERS for actions by <a href="https://github.com/TingluoHuang"><code>@TingluoHuang</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2224">actions/checkout#2224</a></li> <li>Update package dependencies by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2236">actions/checkout#2236</a></li> </ul> <h2>v4.2.2</h2> <ul> <li><code>url-helper.ts</code> now leverages well-known environment variables by <a href="https://github.com/jww3"><code>@jww3</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1941">actions/checkout#1941</a></li> <li>Expand unit test coverage for <code>isGhes</code> by <a href="https://github.com/jww3"><code>@jww3</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1946">actions/checkout#1946</a></li> </ul> <h2>v4.2.1</h2> <ul> <li>Check out other refs/* by commit if provided, fall back to ref by <a href="https://github.com/orhantoy"><code>@orhantoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1924">actions/checkout#1924</a></li> </ul> <h2>v4.2.0</h2> <ul> <li>Add Ref and Commit outputs by <a href="https://github.com/lucacome"><code>@lucacome</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1180">actions/checkout#1180</a></li> <li>Dependency updates by <a href="https://github.com/dependabot"><code>@dependabot</code></a>- <a href="https://redirect.github.com/actions/checkout/pull/1777">actions/checkout#1777</a>, <a href="https://redirect.github.com/actions/checkout/pull/1872">actions/checkout#1872</a></li> </ul> <h2>v4.1.7</h2> <ul> <li>Bump the minor-npm-dependencies group across 1 directory with 4 updates by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1739">actions/checkout#1739</a></li> <li>Bump actions/checkout from 3 to 4 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1697">actions/checkout#1697</a></li> <li>Check out other refs/* by commit by <a href="https://github.com/orhantoy"><code>@orhantoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1774">actions/checkout#1774</a></li> <li>Pin actions/checkout's own workflows to a known, good, stable version. by <a href="https://github.com/jww3"><code>@jww3</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1776">actions/checkout#1776</a></li> </ul> <h2>v4.1.6</h2> <ul> <li>Check platform to set archive extension appropriately by <a href="https://github.com/cory-miller"><code>@cory-miller</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1732">actions/checkout#1732</a></li> </ul> <h2>v4.1.5</h2> <ul> <li>Update NPM dependencies by <a href="https://github.com/cory-miller"><code>@cory-miller</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1703">actions/checkout#1703</a></li> <li>Bump github/codeql-action from 2 to 3 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1694">actions/checkout#1694</a></li> <li>Bump actions/setup-node from 1 to 4 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1696">actions/checkout#1696</a></li> <li>Bump actions/upload-artifact from 2 to 4 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1695">actions/checkout#1695</a></li> <li>README: Suggest <code>user.email</code> to be <code>41898282+github-actions[bot]@users.noreply.github.com</code> by <a href="https://github.com/cory-miller"><code>@cory-miller</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1707">actions/checkout#1707</a></li> </ul> <h2>v4.1.4</h2> <ul> <li>Disable <code>extensions.worktreeConfig</code> when disabling <code>sparse-checkout</code> by <a href="https://github.com/jww3"><code>@jww3</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1692">actions/checkout#1692</a></li> <li>Add dependabot config by <a href="https://github.com/cory-miller"><code>@cory-miller</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1688">actions/checkout#1688</a></li> <li>Bump the minor-actions-dependencies group with 2 updates by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1693">actions/checkout#1693</a></li> <li>Bump word-wrap from 1.2.3 to 1.2.5 by <a href="https://github.com/dependabot"><code>@dependabot</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1643">actions/checkout#1643</a></li> </ul> <h2>v4.1.3</h2> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/actions/checkout/commit/08c6903cd8c0fde910a37f88322edcfb5dd907a8"><code>08c6903</code></a> Prepare v5.0.0 release (<a href="https://redirect.github.com/actions/checkout/issues/2238">#2238</a>)</li> <li><a href="https://github.com/actions/checkout/commit/9f265659d3bb64ab1440b03b12f4d47a24320917"><code>9f26565</code></a> Update actions checkout to use node 24 (<a href="https://redirect.github.com/actions/checkout/issues/2226">#2226</a>)</li> <li>See full diff in <a href="https://github.com/actions/checkout/compare/v4...v5">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bump PSModule/Process-PSModule from 3 to 4 (#9) - Move `mkdocs.yml` to `.github` - Bumps [PSModule/Process-PSModule](https://github.com/psmodule/process-psmodule) from 3 to 4. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/psmodule/process-psmodule/releases">PSModule/Process-PSModule's releases</a>.</em></p> <blockquote> <h2>v3.2.17</h2> <!-- raw HTML omitted --> <h2>What's Changed</h2> <h3>Other Changes</h3> <ul> <li>🪲 [Fix]: Fix placement of docs after copy by <a href="https://github.com/MariusStorhaug"><code>@MariusStorhaug</code></a> in <a href="https://redirect.github.com/PSModule/Process-PSModule/pull/138">PSModule/Process-PSModule#138</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.17">https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.17</a></p> <h2>v3.2.16</h2> <!-- raw HTML omitted --> <h2>What's Changed</h2> <h3>Other Changes</h3> <ul> <li>🪲 [Fix]: Fix an issue that break the workflow when there is nothing to commit in <code>BuildDocs</code> by <a href="https://github.com/MariusStorhaug"><code>@MariusStorhaug</code></a> in <a href="https://redirect.github.com/PSModule/Process-PSModule/pull/137">PSModule/Process-PSModule#137</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.16">https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.16</a></p> <h2>v3.2.15</h2> <!-- raw HTML omitted --> <h2>What's Changed</h2> <h3>Other Changes</h3> <ul> <li>🩹 [Patch]: Merge <code>Docs</code> jobs into one by <a href="https://github.com/MariusStorhaug"><code>@MariusStorhaug</code></a> in <a href="https://redirect.github.com/PSModule/Process-PSModule/pull/136">PSModule/Process-PSModule#136</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.15">https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.15</a></p> <h2>v3.2.14</h2> <!-- raw HTML omitted --> <h2>What's Changed</h2> <h3>Other Changes</h3> <ul> <li>🩹 [Patch]: Separate Docs from Build by <a href="https://github.com/MariusStorhaug"><code>@MariusStorhaug</code></a> in <a href="https://redirect.github.com/PSModule/Process-PSModule/pull/135">PSModule/Process-PSModule#135</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.14">https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.14</a></p> <h2>v3.2.13</h2> <!-- raw HTML omitted --> <h2>What's Changed</h2> <h3>Other Changes</h3> <ul> <li>🩹 [Patch]: Reverting Co-location by <a href="https://github.com/MariusStorhaug"><code>@MariusStorhaug</code></a> in <a href="https://redirect.github.com/PSModule/Process-PSModule/pull/134">PSModule/Process-PSModule#134</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.13">https://github.com/PSModule/Process-PSModule/compare/v3...v3.2.13</a></p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/PSModule/Process-PSModule/commit/c8734f22113a2846ae56db478c58ff7d73acbc59"><code>c8734f2</code></a> 🩹 [Docs]: Remove unnecessary blank line from README.md for improved readability</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/cfa7a190db05831e75f4311d3f5556f05b8fb5f2"><code>cfa7a19</code></a> 🩹 [Docs]: Add a blank line to README.md for improved readability</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/28913944a6e368a9220357d0e92b360959ca49d6"><code>2891394</code></a> 🩹 [Docs]: Remove unnecessary blank line from README.md for improved readability</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/894a2288ec2491d1d425d2d88f424aea20558a44"><code>894a228</code></a> 🩹 [Docs]: Add a blank line to README.md for improved readability</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/12ae4956fb4c02ed942ad4f8c11a9e5a9f1b3644"><code>12ae495</code></a> 🩹 [Docs]: Remove unnecessary blank line from README.md for improved readability</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/73b9cabaea65fff5b2cdc1be33d5091c3bbb028a"><code>73b9cab</code></a> 🩹 [Docs]: Add a blank line to README.md for improved formatting</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/6ff3216d5304d77b32f2b326d321ea4ce026788a"><code>6ff3216</code></a> 🩹 [Docs]: Remove unnecessary blank line from README.md for improved readability</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/8a30c872d0cdaf5ebe0a4da45fac3af94415c353"><code>8a30c87</code></a> 🩹 [Refactor]: Remove Get-CodeCoverage workflow to streamline CI configuration</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/49e39c0a8966003f3c76b8f90fc654bd909a4287"><code>49e39c0</code></a> 🩹 [Refactor]: Remove WorkingDirectory input from Get-CodeCoverage workflow fo...</li> <li><a href="https://github.com/PSModule/Process-PSModule/commit/b0ddbcca04cb9b5bd86675869cb4f47f3402ae84"><code>b0ddbcc</code></a> 🩹 [Refactor]: Remove redundant checkout step and add Get-CodeCoverage workflo...</li> <li>Additional commits viewable in <a href="https://github.com/psmodule/process-psmodule/compare/v3...v4">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Marius Storhaug <marstor@hotmail.com>
🪲 [Fix]: Update test to adjust output rendering (#10) ## Description This pull request includes a small change to the `tests/Markdown.Tests.ps1` file. The change configures the PowerShell output rendering style before and after running tests to ensure consistent output formatting. This to ensure that comparison can be done without counting in rendering. * Added `BeforeAll` block to set `$PSStyle.OutputRendering` to 'Host' before tests run. * Added `AfterAll` block to reset `$PSStyle.OutputRendering` to 'Ansi' after tests complete. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [x] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ]⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
🚀 [Feature]: Update `Set-MarkdownCodeBlock` to optionally execute the… … command and use the output (#6) ## Description This pull request updates the `Set-MarkdownCodeBlock` function to execute a script block and capture its output for inclusion in a Markdown code block. ### Enhancements to `Set-MarkdownCodeBlock` function: * Added a new parameter `-Execute` to control whether the script block should be executed or its literal text captured. ### Updates to tests * Added a new test case to validate that the `Set-MarkdownCodeBlock` function correctly executes a script block and renders the output as a fenced code block. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ]⚠️ [Security fix] - [x] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
🚀 [Feature]: Add `Set-MarkdownParagraph` function (#5) ## Description This pull request introduces a new function, `Set-MarkdownParagraph`, to generate Markdown paragraphs dynamically. It also includes tests to ensure the correct functionality of this new feature. ### New function * `Set-MarkdownParagraph`: * Added a new function that captures the output of a script block and formats it as a Markdown paragraph. It includes options to wrap the content in HTML `<p>` tags. ### Testing * `tests/Markdown.Tests.ps1`: * Added tests for `Set-MarkdownParagraph` to verify it can render a simple Markdown paragraph and a paragraph with HTML `<p>` tags. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ]⚠️ [Security fix] - [x] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
🌟 [Major]: Introducing the `Markdown` module (#3) ## Description This pull request introduces the `Markdown` PowerShell module with functions for generating Markdown content programmatically using a DSL. - Fixes #2 ### New Functions for Markdown Generation: * `Set-MarkdownCodeBlock`: Added a function to generate fenced code blocks for Markdown using the specified language. * `Set-MarkdownDetails`: Added a function to generate collapsible Markdown details blocks with a summary title and formatted content. * `Set-MarkdownSection`: Added a function to create formatted Markdown sections with specified header levels, titles, and content. * `Set-MarkdownTable`: Added a function to convert objects from a script block into a Markdown table. ### Documentation and Examples: * `README.md`: Updated the documentation to describe the new DSL commands for generating Markdown content, including headings, details, code blocks, and tables. * `examples/General.ps1`: Updated the example script to demonstrate the usage of the new DSL commands for generating a complete Markdown document. ### Tests: * `tests/Markdown.Tests.ps1`: Added Pester tests for the new functions to ensure they generate the expected Markdown content. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ]⚠️ [Security fix] - [ ] 🚀 [Feature] - [x] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
Init (#1) ## Description <!-- Add your description here --> ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ]⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas