Skip to content

docs: initialize v0.8 to v1.0 migration guide skeleton#123

Draft
tablackburn wants to merge 1 commit into
mainfrom
docs/migration-guide-skeleton
Draft

docs: initialize v0.8 to v1.0 migration guide skeleton#123
tablackburn wants to merge 1 commit into
mainfrom
docs/migration-guide-skeleton

Conversation

@tablackburn
Copy link
Copy Markdown
Contributor

Phase 1 of #120. Initializes docs/migration-v0.8-to-v1.0.md so Phase 2+ breaking PRs have a defined home for migration entries and the v1.0.0 deliverable AI-assisted migration prompt has a stable, versioned location.

What's included

  • docs/migration-v0.8-to-v1.0.md (new) — empty skeleton with:
    • Scope blurb (audience, non-scope link to CHANGELOG.md)
    • Quick Start placeholder ("no breaking changes have landed yet; this list will be populated by Phase 2 PRs")
    • AI-assisted migration prompt — referential style, designed for IDE/CLI agents (Claude Code, Copilot CLI/Chat, Cursor, Aider) that have file-system access. Tells the agent to read this guide + the user's build file and migrate it; flags uncertain spots with # MIGRATION-REVIEW: comments.
    • Migration entries section with one clearly-labeled illustrative example entry (fictional break) demonstrating the loose format. Wrapped in HTML comments instructing the first real Phase 2 PR to delete it.
    • Adding an entry spec for PR contributors — loose format conventions modeled on psake/psake docs/migration-v4-to-v5.md: heading + prose + Before/After code blocks, with the rigid 5-field template downgraded to suggested subsections.
    • Related links to [Tracking] PowerShellBuild v1.0.0 roadmap #120 and the sibling-repo convention.
  • CHANGELOG.md — one-line entry under ## Unreleased / ### Added.

Org convention alignment

Path diverges from #120's original spec:

Reason: psake/psake already ships a sibling-pattern migration guide at docs/migration-v4-to-v5.md. Matching the org convention reduces cross-repo friction. #120's body has been updated to reference the new path.

Scope

Docs-only — no code, dependency, or workflow changes. The illustrative entry is fictional and gets deleted by the first real Phase 2 PR.

Not in this PR

  • instructions/git-workflow.instructions.md — left alone (upstream AIM template). The "Adding an entry" spec for PR authors lives inside the migration file itself.
  • Real migration entries — added by Phase 2 PRs as breaks land.

Test plan

  • CI passes (existing required checks)
  • Visual review on GitHub: prompt block renders as a code block, entry headings anchor cleanly
  • Confirm flat path matches the psake/psake convention

🤖 Generated with Claude Code

Phase 1 of #120. Creates docs/migration-v0.8-to-v1.0.md (matching the
psake/psake docs/migration-v4-to-v5.md convention) with:
- Scope blurb and Quick Start placeholder
- AI-assisted migration prompt (referential style for IDE/CLI agents)
- One labeled illustrative entry showing the loose format
- "Adding an entry" spec for future breaking-change PRs

Adds a one-line CHANGELOG entry under Unreleased. No code or
dependency changes.

Path diverges from #120's original spec (docs/migration/v0.8-to-v1.0.md)
to match the org-level convention established by psake/psake. #120's
body has been updated to reference the new flat path.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@tablackburn tablackburn added this to the v1.0.0 milestone May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant