Skip to content

Commit 0a152c6

Browse files
tablackburnclaude
andcommitted
docs: make migration skeleton read sensibly pre-release
Browsing docs/ before v1.0.0 ships, the migration guide implied either that there were no breaking changes or that it was unfinished, and the fictional example entry could be mistaken for a real break. - Add a pre-release banner stating v1.0.0 has not shipped and there is nothing to migrate yet, linking the roadmap (#120). - Replace the rendered fictional example with a "no entries yet" note and move the example into an HTML comment as a contributor-only template. No change to the entry format or AI-assisted prompt. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015cqAkNY5JkcoroyEAmbeVj
1 parent 133ff1c commit 0a152c6

1 file changed

Lines changed: 25 additions & 21 deletions

File tree

docs/migration-v0.8-to-v1.0.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Migrating from PowerShellBuild v0.8 to v1.0
22

3+
> 🚧 **Pre-release.** v1.0.0 has not shipped yet, and no breaking changes
4+
> have been documented here. This guide is being prepared alongside the
5+
> v1.0.0 work; entries are added by each breaking-change PR as it lands.
6+
> Track progress in
7+
> [#120 — PowerShellBuild v1.0.0 roadmap](https://github.com/psake/PowerShellBuild/issues/120).
8+
> If you are on 0.8.x today, there is nothing to migrate yet.
9+
310
This guide helps you upgrade a consumer `build.ps1` (or equivalent) from
411
PowerShellBuild **0.8.x** to **1.0.0**.
512

@@ -70,38 +77,34 @@ PowerShellBuild conventions worth knowing:
7077

7178
## Migration entries
7279

73-
<!--
74-
EXAMPLE ENTRY — REPLACE OR REMOVE WHEN THE FIRST REAL ENTRY LANDS.
75-
76-
This entry uses a FICTIONAL change to demonstrate the format. Real
77-
entries are added by Phase 2 PRs as breaking changes land. See
78-
"Adding an entry" below for the spec.
79-
-->
80+
_No breaking changes documented yet._ Each breaking-change PR adds its
81+
entry here as it lands; see [Adding an entry](#adding-an-entry-for-pr-contributors)
82+
below for the format.
8083

81-
### Example: `Invoke-PSBuildPlaceholder` renamed its `-LegacyOption` parameter
84+
<!--
85+
TEMPLATE / EXAMPLE ENTRY — for PR contributors only; not rendered to
86+
readers. Copy this structure for a real entry. It uses a FICTIONAL change
87+
to demonstrate the format; the first real entry's PR can remove this
88+
comment block.
8289
83-
> **This is an illustrative example only — not a real break.**
90+
### `Invoke-PSBuildPlaceholder` renamed its `-LegacyOption` parameter
8491
85-
The hypothetical function `Invoke-PSBuildPlaceholder` renamed its
86-
`-LegacyOption` parameter to `-StandardOption`. The behavior is
87-
otherwise unchanged.
92+
The function `Invoke-PSBuildPlaceholder` renamed its `-LegacyOption`
93+
parameter to `-StandardOption`. The behavior is otherwise unchanged.
8894
8995
**Before (0.8.x):**
9096
91-
```powershell
92-
Invoke-PSBuildPlaceholder -LegacyOption 'value'
93-
```
97+
Invoke-PSBuildPlaceholder -LegacyOption 'value'
9498
9599
**After (1.0.0):**
96100
97-
```powershell
98-
Invoke-PSBuildPlaceholder -StandardOption 'value'
99-
```
101+
Invoke-PSBuildPlaceholder -StandardOption 'value'
100102
101103
You will see a parameter-binding error referencing `LegacyOption` if you
102104
do not migrate.
103105
104-
Tracked in hypothetical PR #999.
106+
Tracked in PR #999.
107+
-->
105108

106109
## Adding an entry (for PR contributors)
107110

@@ -127,8 +130,9 @@ Also:
127130
to your new entry's heading.
128131
- Reference this guide from your PR description (the entry it adds).
129132

130-
The illustrative example entry above can be deleted by the first real
131-
entry's PR — it exists only to show the format.
133+
A commented-out template entry lives in the **Migration entries** section
134+
above (visible only in the raw Markdown) — copy it as a starting point.
135+
The first real entry's PR can remove that comment block.
132136

133137
## Related
134138

0 commit comments

Comments
 (0)