Skip to content

docs: Finalize the migration guide and test the AI migration prompt #200

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

Open
tablackburn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Finalize the migration guide and test the AI migration prompt #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 31 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,37 @@

## Unreleased

PowerShellBuild 1.0.0 is the first stable release. It closes a cycle of
breaking changes that brings every core dependency to a current major
version and fixes several gates that reported problems without enforcing
them.

**Read [docs/migration-v0.8-to-v1.0.md](docs/migration-v0.8-to-v1.0.md)
before upgrading.** It carries one entry per break with the migration steps
for each, and a prompt you can hand to a coding agent to do the edits for
you.

The breaks that can require action, shortest first:

| Change | Who it affects |
| --- | --- |
| psake floor raised to `5.0.4` | psake consumers on 4.x — the module will not import |
| Pester floor raised to `6.0.0` | consumers pinned to Pester 5.x — the module will not import |
| PlatyPS moved to `Microsoft.PowerShell.PlatyPS` 1.x and is no longer installed for you | anyone who builds help |
| `$PSBPreference.Docs.AlphabeticParamsOrder` removed | anyone who set it |
| Manifest now requires PowerShell 5.1 | anyone building on PowerShell 3.0 or 4.0 |
| Script analysis thresholds are enforced for the first time | anyone running the `Analyze` task — a build that passed may now correctly fail |
| `ParseError` findings now count as errors | anyone with a file that does not parse |

Three fixes are worth checking your build file for even though they cannot
break it, because each one means a setting you configured was doing nothing:
`$PSBPreference.Test.ScriptAnalysisEnabled` was never a real setting name,
code coverage percentages were truncated to zero so coverage gating could not
be used at all, and under Invoke-Build the coverage report was written in a
format the threshold gate could not read.

Everything below is the detail, one entry per issue.

### Changed

- [**#172**](https://github.com/psake/PowerShellBuild/issues/172)
Expand Down Expand Up @@ -191,7 +222,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 225 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
Loading
Loading