🪲 [Fix]: Keep VS Code snippet files out of the ignore list - #41
Open
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Open
🪲 [Fix]: Keep VS Code snippet files out of the ignore list#41Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Conversation
The canonical github/gitignore VS Code template un-ignores .vscode/*.code-snippets; the template dropped it, so workspace snippets committed on purpose are invisible to git in every repository created from it. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
No Significant Changes DetectedThis PR does not contain changes to files that would trigger a new release:
Build, test, and publish stages will be skipped for this PR. If you believe this is incorrect, please verify that your changes are in the correct locations. |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
added a commit
to PSModule/PSSemVer
that referenced
this pull request
Aug 2, 2026
…current pipeline (#46) `New-PSSemVer` and `ConvertTo-PSSemVer` now carry correct, linkable help, and the repository runs the current Process-PSModule pipeline with the governance and documentation files the PSModule Repository Standard expects. The `[PSSemVer]` class and the exported commands behave exactly as before. ## Fixed: Command help names real commands and links to the documentation Both commands' examples referenced `New-SemVer` and `ConvertTo-SemVer` — commands this module does not export, so anyone copying `Get-Help -Examples` output got a `CommandNotFoundException`. Neither command had a `.LINK`, so `Get-Help -Online` had nowhere to go. Each now opens with its canonical `psmodule.io` documentation URL, followed by the SemVer specification. This also unblocks CI: Process-PSModule v6 enforces `PublicHelpLink`, and `Test-SourceCode` failed on all three runners before the fix. ## Changed: Process-PSModule refreshed to v6.1.15 The caller workflow was pinned to v5.4.6 and used `secrets: inherit`. v6.0.0 removed the fixed `TEST_*` secret inputs in favour of an explicit `TestData` object, so inheriting every repository secret is no longer needed. PSSemVer has no test secrets, so the caller now passes only `APIKey`, matching `Template-PSModule` and `PSModule/GitHub`. ## Changed: Documentation site config moved to Zensical Process-PSModule v6.1.13 made `Build-Site` Zensical-only, so `.github/mkdocs.yml` was dead configuration and the site was being built from framework defaults. It is replaced by the `.github/zensical.toml` that `Template-PSModule` ships. ## New: Required governance and agent onboarding files The repository now carries its own `CONTRIBUTING.md`, `SECURITY.md`, `SUPPORT.md`, `CODE_OF_CONDUCT.md`, `AGENTS.md`, `CLAUDE.md`, and `.github/pull_request_template.md` instead of relying on the organization `.github` fallback, which agents, linters, and local tooling never read. The README already linked to `CONTRIBUTING.md`, which did not exist. ## Changed: README follows the module start-page standard Installation uses `Install-PSResource` instead of the deprecated `Install-Module`. The exhaustive per-method example list is replaced by a capabilities showcase covering parsing with a prefix and metadata, SemVer precedence, in-place bumping, and pipeline conversion — every snippet was executed against the module before being written down. The page links to the published documentation at psmodule.io/PSSemVer. ## Technical Details - `.github/workflows/Process-PSModule.yml`: `@205d193 # v5.4.6` -> `@688896d # v6.1.15`, `secrets: inherit` -> `secrets: APIKey`. - `.github/mkdocs.yml` deleted, `.github/zensical.toml` added. - `.github/dependabot.yml`: `github-actions` moved to a daily interval with a 7-day cooldown, matching the template default. - `tests/PSSemVer.Tests.ps1` now declares `#Requires -Modules @{ ModuleName = 'Pester'; ModuleVersion = '6.0.0'; MaximumVersion = '6.*' }`, so a runner with Pester 5 available can no longer silently run the wrong version. A forced `-Verbose` write that only added log noise is gone. - Governance files are the `Template-PSModule` copies; `AGENTS.md` is adapted to describe PSSemVer and to flag that the public class shape is the module API. - `.gitignore` intentionally keeps `!.vscode/*.code-snippets`, which the template is missing relative to the canonical `github/gitignore` VS Code template — see PSModule/Template-PSModule#41. - Verified before pushing: 66/66 Pester 6 tests pass against a built artifact, and PSScriptAnalyzer is clean over `src/` and `tests/` with the repo linter settings. ### Review findings filed separately The behaviour review of `[PSSemVer]` found defects that change the public class contract, so they are not folded into this change. <details> <summary>Related issues</summary> - Reported #47 - Reported #48 - Reported #49 - Reported #50 - Reported #51 - Reported #52 - Reported PSModule/Process-PSModule#438 </details> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
August 2, 2026 16:59
Marius Storhaug (MariusStorhaug)
requested a review
from a team
as a code owner
August 2, 2026 16:59
No Significant Changes DetectedThis PR does not contain changes to files that would trigger a new release:
Build, test, and publish stages will be skipped for this PR. If you believe this is incorrect, please verify that your changes are in the correct locations. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Repositories created from this template can once again commit VS Code workspace snippets.
Fixed:
.vscode/*.code-snippetsis no longer ignoredThe
.vscodeblock in.gitignoreignores the whole folder and then un-ignores the files a team is expected to share. The canonicalgithub/gitignoreVS Code template un-ignoressettings.json,tasks.json,launch.json,extensions.json, and*.code-snippets. This template dropped the last one, so a workspace snippet file added on purpose stayed invisible to git in every repository generated from the template.Noticed while aligning
PSModule/PSSemVerto the repository standard: PSSemVer still carries the line, so syncing it to the template would have been a regression.Technical Details
.gitignore: adds!.vscode/*.code-snippetsafter!.vscode/extensions.json, matching the canonical ordering.Related issues