Skip to content

docs(changelog): add v3.0.3, v3.1.0, v3.1.1 entries - #14

Merged
David Mireles (louzt) merged 1 commit into
mainfrom
docs/changelog-v3-backfill
Jul 31, 2026
Merged

docs(changelog): add v3.0.3, v3.1.0, v3.1.1 entries#14
David Mireles (louzt) merged 1 commit into
mainfrom
docs/changelog-v3-backfill

Conversation

@louzt

@louzt louzt commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

Summary

The CHANGELOG.md was last updated for v2.1.0 (2025-11-10) and missed the
entire v3.x release line. After PR #11 dropped docs/WHATS_NEW_V2.{1,2}.md,
CHANGELOG.md became the sole release-notes surface — and it was already
6 months stale. This PR backfills the v3.x entries.

Changes

Version Date Section Source
3.1.1 2026-07-28 docs-only PATCH (drop WHATS_NEW_V2 dupes; binary remains 3.1.0) v3.1.1 release notes disclaimer
3.1.0 2026-07-04 NSIS bundler fix, netboozt-service removal, clippy cleanup v3.1.0 release notes
3.0.3 2026-03-27 Performance & Build Improvements (MSI + NSIS) v3.0.3 release notes

Why this PR

  • CHANGELOG.md declares itself as canonical per Keep-a-Changelog format.
  • GitHub Releases is a complementary surface (per-release binary download),
    not a replacement for the Keep-a-Changelog format tooling consumes.
  • Without this backfill, the docs cleanup in PR chore(docs): drop WHATS_NEW_V2.{1,2}.md (CHANGELOG dupes) #11 would have removed the
    only available notes for the entire v3.x release line.

Out of scope

  • No code changes. No version bump. No new release.
  • The Windows installer binary remains functionally identical to v3.1.0;
    Cargo.toml was not touched (same pattern as the v3.1.1 PATCH release).

Verification

  • git diff --stat main...docs/changelog-v3-backfill → 1 file changed, 32 insertions
  • CHANGELOG.md still follows Keep-a-Changelog format
  • No formatting / lint CI run needed (markdown only)

Summary by CodeRabbit

  • Documentation
    • Added release notes for version 3.1.1.
    • Clarified that this is a documentation-only release with no installer or functional changes.
    • Removed duplicated release note content.

The CHANGELOG.md was last updated for v2.1.0 (2025-11-10) and missed
the entire v3.x release line. This commit backfills:

- v3.0.3 (2026-03-27) — Performance & Build Improvements
- v3.1.0 (2026-07-04) — NSIS bundler fix, netboozt-service removal,
  clippy cleanup
- v3.1.1 (2026-07-28) — docs-only PATCH (drop WHATS_NEW_V2 dupes;
  binary version inside installer remains 3.1.0 because Cargo.toml
  was not bumped for a docs-only commit)

Entries paraphrased from the corresponding GitHub Releases notes
to keep the Keep-a-Changelog format consistent with v2.x entries.

**Why:** CHANGELOG.md is the canonical project changelog per its
own header ("this project adheres to Semantic Versioning"). GitHub
Releases is a complementary surface, not a replacement.

**Refs:**
- #11 (drop WHATS_NEW_V2.{1,2}.md, the source of this gap)
- v3.1.1 release notes (the docs-only PATCH explanation)
- v3.0.3 / v3.1.0 release notes
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 252c97f0-388b-42d9-8cbd-3a03daa486e5

📥 Commits

Reviewing files that changed from the base of the PR and between 00ed2a3 and c6c796e.

📒 Files selected for processing (1)
  • CHANGELOG.md

📝 Walkthrough

Walkthrough

The changelog adds a dated v3.1.1 entry for a documentation-only patch. It records the removed duplicate documentation file and unchanged installer behavior and version metadata. Existing v3.1.0, v3.0.3, and installer notes remain below it.

Changes

Changelog update

Layer / File(s) Summary
Release note history
CHANGELOG.md
The changelog adds the v3.1.1 release entry and restores the existing v3.1.0, v3.0.3, and installer notes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the changelog entries added by this pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/changelog-v3-backfill

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

Comment @coderabbitai help to get the list of available commands.

@louzt
David Mireles (louzt) merged commit 05f8f6a into main Jul 31, 2026
3 checks passed
@louzt
David Mireles (louzt) deleted the docs/changelog-v3-backfill branch July 31, 2026 02:37
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