Breaking changes and Migration Guide for v2.0.0

[christianhelle]

Guidance for upcoming version 2.0.0

[coderabbitai]

📝 Walkthrough

Walkthrough

The PR updates CI/CD workflow version numbers from 1.8.0 to 2.0.0 across multiple GitHub Actions files and adds comprehensive breaking changes documentation for v2.0.0, including investigation summaries, discussion drafts, user-facing migration guides, and process tracking across squad coordination files.

Changes

Cohort / File(s)	Summary
CI/CD Workflow Version Bumps .github/workflows/build.yml, codecov.yml, release-preview.yml, release.yml	Updated VERSION environment variable and version inputs from 1.8.0 to 2.0.0 (and 1.8.0-preview to 2.0.0-preview). These changes propagate to dotnet build steps and release templates.
Breaking Changes Investigation & Planning .squad/agents/bishop/breaking-changes-investigation-summary.md, discussion-post-breaking-changes-v2.0.0.md, history.md	Added investigation summary document (114 lines) identifying two breaking changes: authentication config rename (generateAuthenticationHeader → authenticationHeaderStyle) and source generator disk file removal. Created draft GitHub Discussion post (185 lines) with migration guidance, examples, and upgrade checklist. Extended bishop history tracking the investigation workflow and deliverables.
Communication & Distribution Audit Tracking .squad/agents/dallas/history.md, .squad/agents/ripley/history.md	Extended dallas history with GitHub Discussions setup audit and breaking-change distribution evidence. Extended ripley history (52 lines) documenting multi-phase Discussion post execution plan, review/approval workflow, and publication readiness.
User-Facing Breaking Changes Documentation docs/docfx_project/articles/breaking-changes-v2-0-0.md, toc.yml	Added new migration guide (157 lines) documenting authentication configuration rename with before/after JSON examples and step-by-step instructions, plus source generator behavioral change and IDE/CLI workflow alternatives. Added TOC entry linking to the new breaking changes article.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Whiskers twitching with delight,
Version two now shines so bright,
Breaking changes wrapped up neat,
With guides so clear, migration's sweet!
From one-point-eight to twenty-oh,
The burrow's code now has a glow! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main changes: documenting breaking changes for v2.0.0 and providing migration guidance, plus a version bump to v2.0.0.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch breaking-changes-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

🧹 Nitpick comments (3)

.squad/agents/bishop/breaking-changes-investigation-summary.md (1)

102-111: Add language identifier to fenced code block.

The fenced code block showing the directory structure should specify a language identifier for proper rendering and to satisfy markdown linting rules.

📝 Suggested fix

-```
+```text
 .squad/
 ├── decisions/inbox/
 │   └── bishop-discussion-shape.md          ✅ NEW

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.squad/agents/bishop/breaking-changes-investigation-summary.md around lines
102 - 111, The fenced code block in breaking-changes-investigation-summary.md is
missing a language identifier which breaks markdown linting; update the opening
fence for the directory tree in
.squad/agents/bishop/breaking-changes-investigation-summary.md to include an
explicit language tag (e.g., ```text or ```bash) so the directory structure
renders correctly and satisfies the linter.

.squad/agents/bishop/discussion-post-breaking-changes-v2.0.0.md (1)

84-92: Add language identifier to fenced code block.

The fenced code block showing the before/after build behavior should specify a language identifier for proper rendering and markdown linting compliance.

📝 Suggested fix

-```
+```text
 // ❌ OLD BEHAVIOR (v1.7.3)
 dotnet build
 → Generated/RefitterClient.g.cs ✅ (file appears on disk)

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.squad/agents/bishop/discussion-post-breaking-changes-v2.0.0.md around lines
84 - 92, The fenced code block showing OLD/NEW behavior lacks a language
identifier; update the triple-backtick fence(s) around the block containing the
lines with "❌ OLD BEHAVIOR (v1.7.3)" and "✅ NEW BEHAVIOR (v2.0.0)" so they
include a language tag (e.g., use ```text) immediately after the opening
backticks to satisfy markdown linting and ensure proper rendering in the file
.squad/agents/bishop/discussion-post-breaking-changes-v2.0.0.md; make the change
for both fenced blocks if there are two separate examples.

docs/docfx_project/articles/toc.yml (1)

10-11: Consider more prominent TOC placement for breaking changes.

The "Breaking Changes (v2.0.0)" entry is currently positioned after "Source Generator" and before "MSBuild". For a major version release, consider placing it near the top of the TOC (positions 1-3) to ensure upgrading users see it immediately.

Alternative placement suggestions:

• Position 1 (before CLI Tool) for maximum visibility during v2.0.0 rollout
• Create a dedicated "Migration & Upgrade" section

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/docfx_project/articles/toc.yml` around lines 10 - 11, Move the "Breaking
Changes (v2.0.0)" TOC entry so it appears prominently near the top of the table
of contents (positions 1–3) or create a new "Migration & Upgrade" section and
place the "Breaking Changes (v2.0.0)" entry there; update the YAML block that
defines the entry with name: "Breaking Changes (v2.0.0)" and href:
"breaking-changes-v2-0-0.md" to the new location in the toc.yml ordering (ensure
indentation and list ordering remain valid).

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.squad/agents/bishop/breaking-changes-investigation-summary.md:
- Around line 102-111: The fenced code block in
breaking-changes-investigation-summary.md is missing a language identifier which
breaks markdown linting; update the opening fence for the directory tree in
.squad/agents/bishop/breaking-changes-investigation-summary.md to include an
explicit language tag (e.g., ```text or ```bash) so the directory structure
renders correctly and satisfies the linter.

In @.squad/agents/bishop/discussion-post-breaking-changes-v2.0.0.md:
- Around line 84-92: The fenced code block showing OLD/NEW behavior lacks a
language identifier; update the triple-backtick fence(s) around the block
containing the lines with "❌ OLD BEHAVIOR (v1.7.3)" and "✅ NEW BEHAVIOR
(v2.0.0)" so they include a language tag (e.g., use ```text) immediately after
the opening backticks to satisfy markdown linting and ensure proper rendering in
the file .squad/agents/bishop/discussion-post-breaking-changes-v2.0.0.md; make
the change for both fenced blocks if there are two separate examples.

In `@docs/docfx_project/articles/toc.yml`:
- Around line 10-11: Move the "Breaking Changes (v2.0.0)" TOC entry so it
appears prominently near the top of the table of contents (positions 1–3) or
create a new "Migration & Upgrade" section and place the "Breaking Changes
(v2.0.0)" entry there; update the YAML block that defines the entry with name:
"Breaking Changes (v2.0.0)" and href: "breaking-changes-v2-0-0.md" to the new
location in the toc.yml ordering (ensure indentation and list ordering remain
valid).

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: faf4faa6-4835-45a6-bf57-92b62ca0b960

📥 Commits

Reviewing files that changed from the base of the PR and between 6b561bf and d19ff12.

📒 Files selected for processing (11)

• .github/workflows/build.yml
• .github/workflows/codecov.yml
• .github/workflows/release-preview.yml
• .github/workflows/release.yml
• .squad/agents/bishop/breaking-changes-investigation-summary.md
• .squad/agents/bishop/discussion-post-breaking-changes-v2.0.0.md
• .squad/agents/bishop/history.md
• .squad/agents/dallas/history.md
• .squad/agents/ripley/history.md
• docs/docfx_project/articles/breaking-changes-v2-0-0.md
• docs/docfx_project/articles/toc.yml

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.18%. Comparing base (a9f0b3b) to head (d19ff12).
⚠️ Report is 91 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1009   +/-   ##
=======================================
  Coverage   93.18%   93.18%           
=======================================
  Files          27       27           
  Lines        1804     1804           
=======================================
  Hits         1681     1681           
  Misses         49       49           
  Partials       74       74           

Flag	Coverage Δ
unittests	93.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.