Skip to content

docs: Correct the script analysis setting name in the README examples #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tablackburn merged 3 commits into from
Aug 27, 2026
Merged

docs: Correct the script analysis setting name in the README examples #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a53680
fix: Correct the script analysis setting name in the README examples
tablackburn Aug 27, 2026
6e16c95
docs: Correct the impact described in the changelog entry
tablackburn Aug 27, 2026
1d8eeb2
Merge remote-tracking branch 'origin/main' into bugfix/191-readme-scr…
tablackburn Aug 27, 2026
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
12 changes: 12 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,18 @@

### Fixed

- [**#191**](https://github.com/psake/PowerShellBuild/issues/191)
The README's psake and Invoke-Build examples assigned
`$PSBPreference.Test.ScriptAnalysisEnabled`, which is not a setting. The real
one is nested, `$PSBPreference.Test.ScriptAnalysis.Enabled`, as the README's
own settings table has always said. `$PSBPreference` is a plain hashtable, so
the unrecognized name added a key nothing reads and neither errored nor
warned. **Check your own build file if you copied the psake example**: it
assigned `$false`, so script analysis has been running on every build even
though you asked for it off. The Invoke-Build example assigned `$true`, which
is already the default, so that one did nothing either way. Correcting the
name is the whole fix; no module behavior changed.

- [**#185**](https://github.com/psake/PowerShellBuild/issues/185)
Consumers on a non-English Windows PowerShell 5.1 host get the module's
real messages. `PowerShellBuild.psm1` carried a hand-maintained second copy
Expand Down Expand Up @@ -157,7 +169,7 @@
that passed before may now correctly fail.
- [**#96**](https://github.com/psake/PowerShellBuild/issues/96)
`Test-PSBuildScriptAnalysis` no longer fails with a path-resolution error
when `SettingsPath` is not supplied. An unsupplied path was forwarded to

Check warning on line 172 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (unsupplied) Suggestions: (unapplied, unsullied, unspoiled, unstapled, unsupported)
PSScriptAnalyzer as `-Settings ''`, which resolved against the current
directory and threw before any analysis ran, so the function's own
documented example could not run as written.
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
> example.

<p align="center">
<img src="media/psaketaskmodule-256x256.png" alt="Logo">

Check warning on line 28 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (psaketaskmodule)
</p>

## Status - Work in progress
Expand Down Expand Up @@ -90,10 +90,10 @@
| Setting | Default value | Description |
|-------------------------------------------------------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| $PSBPreference.General.ProjectRoot | `$env:BHProjectPath` | Root directory for the project |
| $PSBPreference.General.SrcRootDir | `$env:BHPSModulePath` | Root directory for the module |

Check warning on line 93 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (BHPS) Suggestions: (baps, bops, bhp, BHP, bps)
| $PSBPreference.General.ModuleName | `$env:BHProjectName` | The name of the module. This should match the basename of the PSD1 file |
| $PSBPreference.General.ModuleVersion | `\<computed>` | The version of the module |
| $PSBPreference.General.ModuleManifestPath | `$env:BHPSModuleManifest` | Path to the module manifest (PSD1) |

Check warning on line 96 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (BHPS) Suggestions: (baps, bops, bhp, BHP, bps)
| $PSBPreference.Build.OutDir | `$projectRoot/Output` | Output directory when building the module |
| $PSBPreference.Build.ModuleOutDir | `$outDir/$moduleName/$moduleVersion` | `For internal use only. Do not overwrite. Use '$PSBPreference.Build.OutDir' to set output directory` |
| $PSBPreference.Build.CompileModule | `$false` | Controls whether to "compile" module into single PSM1 or not |
Expand Down Expand Up @@ -124,17 +124,17 @@
| $PSBPreference.Help.ConvertReadMeToAboutHelp | `$false` | Convert project readme into the module about file |
| $PSBPreference.Docs.RootDir | `$projectRoot/docs` | Directory PlatyPS markdown documentation will be saved to. Other content in this directory, such as a README or an images folder, is left alone. |
| $PSBPreference.Docs.Overwrite | `$false` | Overwrite the markdown files in the docs folder using the comment based help as the source of truth. |
| $PSBPreference.Docs.ExcludeDontShow | `$false` | Exclude the parameters marked with `DontShow` in the parameter attribute from the help content. |

Check warning on line 127 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (Dont) Suggestions: (dent, dint, doit, dolt, dona)
| $PSBPreference.Docs.UseFullTypeName | `$false` | Indicates that the target document will use a full type name instead of a short name for parameters. |
| $PSBPreference.Publish.PSRepository | `PSGallery` | PowerShell repository name to publish |
| $PSBPreference.Publish.PSRepositoryApiKey | `$env:PSGALLERY_API_KEY` | API key to authenticate to PowerShell repository with |

Check warning on line 130 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (PSGALLERY) Suggestions: (psaltery, spaller, psaltry, psalter, psalters)
| $PSBPreference.Publish.PSRepositoryCredential | `$null` | Credential to authenticate to PowerShell repository with. Overrides `$psRepositoryApiKey` if defined |
| $PSBPreference.Sign.Enabled | `$false` | Enable/disable Authenticode signing of the built module. Must be `$true` for any of the signing or catalog tasks to run. |
| $PSBPreference.Sign.CertificateSource | `Auto` | How the code-signing certificate is resolved. Valid values are `Auto`, `Store`, `Thumbprint`, `EnvVar`, and `PfxFile`. See [Code signing](#code-signing). |
| $PSBPreference.Sign.CertStoreLocation | `Cert:\CurrentUser\My` | Windows certificate store path searched by the `Store` and `Thumbprint` certificate sources. |
| $PSBPreference.Sign.Thumbprint | `$null` | Thumbprint of the certificate to select from the store. Required by the `Thumbprint` certificate source and ignored by the others. |
| $PSBPreference.Sign.CertificateEnvVar | `SIGNCERTIFICATE` | Name of the environment variable holding the Base64-encoded PFX. Read by the `EnvVar` source, and used by `Auto` to detect whether a certificate is present. |

Check warning on line 136 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (SIGNCERTIFICATE)
| $PSBPreference.Sign.CertificatePasswordEnvVar | `CERTIFICATEPASSWORD` | Name of the environment variable holding the password for the Base64-encoded PFX. Read by the `EnvVar` certificate source. |

Check warning on line 137 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (CERTIFICATEPASSWORD)
| $PSBPreference.Sign.PfxFilePath | `$null` | File system path to a PFX/P12 certificate file. Required by the `PfxFile` certificate source. |
| $PSBPreference.Sign.PfxFilePassword | `$null` | Password for the PFX/P12 file as a `SecureString`. Used by the `PfxFile` certificate source. |
| $PSBPreference.Sign.Certificate | `$null` | A pre-resolved `X509Certificate2` object to sign with. When set, `CertificateSource` is ignored, which suits Azure Key Vault, an HSM, or another custom provider. |
Expand Down Expand Up @@ -226,8 +226,8 @@
properties {
# These settings overwrite values supplied from the PowerShellBuild
# module and govern how those tasks are executed
$PSBPreference.Test.ScriptAnalysisEnabled = $false
$PSBPreference.Test.CodeCoverage.Enabled = $true
$PSBPreference.Test.ScriptAnalysis.Enabled = $false
$PSBPreference.Test.CodeCoverage.Enabled = $true
}

task default -depends Build
Expand All @@ -253,8 +253,8 @@
. PowerShellBuild.IB.Tasks

# Overwrite build settings contained in PowerShellBuild
$PSBPreference.Test.ScriptAnalysisEnabled = $true
$PSBPreference.Test.CodeCoverage.Enabled = $false
$PSBPreference.Test.ScriptAnalysis.Enabled = $true
$PSBPreference.Test.CodeCoverage.Enabled = $false
```

![Example](./media/ib_example.png)
Expand Down
Loading