Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions instructions/repository-specific.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
| `Build` | OutDir, ModuleOutDir, CompileModule, CompileDirectories, CopyDirectories, Exclude |
| `Test` | Enabled, RootDir, OutputFile/Format, ScriptAnalysis, CodeCoverage, ImportModule, etc. |
| `Help` | UpdatableHelpOutDir, DefaultLocale, ConvertReadMeToAboutHelp |
| `Docs` | RootDir, Overwrite, AlphabeticParamsOrder, ExcludeDontShow, UseFullTypeName |

Check warning on line 73 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (Dont) Suggestions: (dent, dint, doit, dolt, dona)
| `Publish` | PSRepository, PSRepositoryApiKey, PSRepositoryCredential |
| `Sign` | Enabled, CertificateSource, CertStoreLocation, Thumbprint, EnvVar/PfxFile sources, TimestampServer, HashAlgorithm, FilesToSign, Catalog |
| `Sign.Catalog` | Enabled, Version, FileName |
Expand Down Expand Up @@ -131,8 +131,8 @@
| `Test-PSBuildPester` | Runs Pester tests with configurable output and coverage |
| `Test-PSBuildScriptAnalysis` | Runs PSScriptAnalyzer with a configurable severity threshold |
| `Publish-PSBuildModule` | Publishes the built module to a PowerShell repository |
| `Get-PSBuildCertificate` | Resolves an Authenticode signing certificate |

Check warning on line 134 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (Authenticode) Suggestions: (authnetcode, Authnetcode, authnetCode, AuthnetCode, authenticate)
| `Invoke-PSBuildModuleSigning` | Signs module files with an Authenticode certificate |

Check warning on line 135 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (Authenticode) Suggestions: (authnetcode, Authnetcode, authnetCode, AuthnetCode, authenticate)
| `New-PSBuildFileCatalog` | Generates a `.cat` file catalog for the module |

Private helper: `Remove-ExcludedItem` — filters file system items by regex patterns during builds.
Expand Down Expand Up @@ -203,9 +203,9 @@
| `BuildHelp` | GenerateMarkdown + GenerateMAML |
| `GenerateUpdatableHelp` | CAB file for updatable help |
| `Publish` | Publish to repository |
| `SignModule` | Authenticode-sign module files (`*.psd1`, `*.psm1`, `*.ps1`) |

Check warning on line 206 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (Authenticode) Suggestions: (authnetcode, Authnetcode, authnetCode, AuthnetCode, authenticate)
| `BuildCatalog` | Create Windows catalog (`.cat`) for the built module |
| `SignCatalog` | Authenticode-sign the module catalog file |

Check warning on line 208 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (Authenticode) Suggestions: (authnetcode, Authnetcode, authnetCode, AuthnetCode, authenticate)
| `Sign` | Meta task — runs the full signing chain |

Tasks with prerequisite modules (`Analyze`, `Pester`, `GenerateMarkdown`, `GenerateMAML`,
Expand All @@ -215,7 +215,7 @@
The signing tasks (`SignModule`, `BuildCatalog`, `SignCatalog`) have similar preconditions:
they skip when `$PSBPreference.Sign.Enabled` is `$false` (catalog tasks also require
`$PSBPreference.Sign.Catalog.Enabled = $true`) or when the required Windows-only cmdlets
(`Set-AuthenticodeSignature`, `New-FileCatalog`) are not available — so signing safely

Check warning on line 218 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (Authenticode) Suggestions: (authnetcode, Authnetcode, authnetCode, AuthnetCode, authenticate)
no-ops on non-Windows.

## Dependencies
Expand All @@ -225,9 +225,9 @@
| Module | Version |
| ---------------- | -------- |
| BuildHelpers | 2.0.16 |
| Pester | ≥ 5.6.1 |
| Pester | 5.8.0 |
| psake | 4.9.0 |
| PSScriptAnalyzer | 1.24.0 |
| PSScriptAnalyzer | 1.25.0 |
| InvokeBuild | 5.8.1 |
| platyPS | 0.14.2 |

Expand Down Expand Up @@ -261,7 +261,7 @@

- Triggers: manual dispatch, GitHub release published
- Runs on: `ubuntu-latest`
- Reads `PSGALLERY_API_KEY` secret, converts to `PSCredential`, runs

Check warning on line 264 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (PSGALLERY) Suggestions: (psaltery, spaller, psaltry, psalter, psalters)
`./build.ps1 -Task Publish -PSGalleryApiKey $cred -Bootstrap`

## Repo-Specific Conventions
Expand Down Expand Up @@ -339,9 +339,9 @@
| ------------------------- | ---------------------------------------------------- |
| `$env:BHProjectPath` | Repository root directory |
| `$env:BHProjectName` | Module name (from directory structure) |
| `$env:BHPSModulePath` | Path to module source directory |

Check warning on line 342 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (BHPS) Suggestions: (baps, bops, bhp, BHP, bps)
| `$env:BHPSModuleManifest` | Path to `.psd1` manifest |

Check warning on line 343 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (BHPS) Suggestions: (baps, bops, bhp, BHP, bps)
| `$env:BHModulePath` | Same as `BHPSModulePath` |

Check warning on line 344 in instructions/repository-specific.instructions.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters

Unknown word (BHPS) Suggestions: (baps, bops, bhp, BHP, bps)
| `$env:BHBuildSystem` | Detected CI system (e.g., `GitHubActions`, `Unknown`)|
| `$env:BHBranchName` | Current git branch |
| `$env:BHCommitMessage` | Latest git commit message |
Expand Down
6 changes: 3 additions & 3 deletions requirements.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
}
BuildHelpers = '2.0.16'
Pester = @{
MinimumVersion = '5.6.1'
Parameters = @{
Version = '5.8.0'
Parameters = @{
SkipPublisherCheck = $true
}
}
psake = '4.9.0'
PSScriptAnalyzer = '1.24.0'
PSScriptAnalyzer = '1.25.0'
InvokeBuild = '5.8.1'
platyPS = '0.14.2'
}
Loading