Tags: PSModule/Template-PSModule
Tags
🩹[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. ```yaml 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` |
🩹 [Patch]: Add example of nested docs (#12) ## Description This pull request introduces several updates to the PSModule functions, including module dependency updates, file restructuring, and new documentation. It also adds a custom argument completer for the `New-PSModuleTest` command. The most important changes are summarized below: ### Module dependency updates and file restructuring * Updated module dependencies in `Get-PSModuleTest.ps1` and `New-PSModuleTest.ps1` to require newer versions of `PSSemVer`, and added dependencies on `DynamicParams` and `Store`. Both files were also moved into the `PSModule` subfolder and renamed accordingly. [[1]](diffhunk://#diff-fba04a7dcc2a3fdf6ced8c431c15ae38c72351bd21fec3705f09d1fbb19343b0R2-R4) [[2]](diffhunk://#diff-67673b63bb813016a3286857ec190afb041ce4352b18c7ba8571de3d6213e771L1-R1) * Updated `.github/PSModule.yml` to configure the linter environment variable `VALIDATE_BIOME_FORMAT` to `false`. ### New features * Added a custom argument completer in `completers.ps1` for the `New-PSModuleTest` command's `Name` parameter, providing suggestions such as 'Alice', 'Bob', and 'Charlie'. ### Documentation * Added a new markdown documentation file `PSModule.md` in the `PSModule` folder. * Added a new markdown documentation file `SomethingElse.md` in the `SomethingElse` folder.
🩹 [Patch]: Encode all PowerShell files using UTF8 with BOM (#11) ## Description This pull request introduces a minor change to the `src/variables/public/Planets.ps1` file, with no impact on logic or functionality. The update appears to be a non-functional change, possibly related to file encoding or the addition of a Byte Order Mark (BOM).
🩹 [Patch]: Add comment for faster testing and ensure linter environme… …nt variables are defined (#10) ## Description This pull request updates the `.github/PSModule.yml` configuration to allow for more flexible and faster testing and linting workflows. The main changes introduce new environment variables to selectively disable specific linter validations and provide a commented-out option to skip some test steps. Workflow configuration improvements: * Added environment variables under the new `Linter` section to allow disabling of various linter validations, including Biome format/lint, GitHub Actions Zizmor, JSCPD, and Prettier checks for JSON, Markdown, and YAML. Test workflow flexibility: * Added a commented-out configuration option to skip some test steps for faster testing during development.
PSModule v5 (#9) ## In this release Bumps the Process-PSModule workflow from v4 to v5, now being possible to "host" all the workflows in a single workflow. This makes you able to move away from the linter.yml and the Nightly-Run.yml, and instead just host everything from the one Process-PSModule.yml workflow. ### Workflow consolidation and scheduling - Updated the reusable workflow version in `.github/workflows/Process-PSModule.yml` from `v4` to `v5` for `PSModule/Process-PSModule/.github/workflows/workflow.yml`, ensuring we use the latest improvements and fixes. - Updated workflow to trigger on both nightly schedule, manual dispatch, and pull requests to `main`, ensuring all use cases are covered in one workflow. - Removed the separate `.github/workflows/Nightly-Run.yml` workflow and merged its nightly schedule and manual trigger into `.github/workflows/Process-PSModule.yml` to streamline job management. - Added `dependencies` and `github-actions` labels to Dependabot updates for GitHub Actions, making it easier to identify and filter these PR, also it will no longer collide with version labels. - Removed the `.github/workflows/Linter.yml` file, which previously ran the Super-Linter on pull requests, likely to reduce redundancy or because linting is now handled in the Process-PSModule. ### QnA - Q: Can I still have the different workflows in my own repo. - A: Yes, you can. You will also soon get settings that will allow you to configure the linter inside the workflow. You can also still bump the version of your nightly runs to v5 and have that on a schedule and manual runs. These do not have to be in a single workflow.
Added placeholder settings for fast iteration (#8) ## Description This pull request adds configuration options to the `.github/PSModule.yml` file to allow skipping various test and build steps. These changes make it easier to customize which checks and builds are run in CI. Configuration changes for skipping steps: * Added options to skip test results, source code checks, and PowerShell module checks in the `Test` section. * Added options to skip Windows and MacOS module checks under the `Module` section. * Added an option to skip documentation builds in the `Build` section. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [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
🩹 [Patch]: Enabled actions to verify the template is in a deployable … …state (#7) ## Description This pull request updates the `.github/PSModule.yml` file to set a meaningful default value for the `Name` field. * [`.github/PSModule.yml`](diffhunk://#diff-928165ed381f1982eb8f9746a59a2829db4abc8a28eddb8c109e12bb033ff96aL6-R6): Changed the `Name` field from `null` to `Template-PSModule` to provide a clear and descriptive default name. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [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