Skip to content

Rewrite the 6.0.0 CHANGELOG for people upgrading - #1938

Merged
tfenne merged 2 commits into
masterfrom
tf_changelog_6_0_rewrite
Oct 26, 2026
Merged

tfenne merged 2 commits into
masterfrom
tf_changelog_6_0_rewrite

Conversation

@tfenne

@tfenne tfenne commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Rewrites the 6.0.0 CHANGELOG section for people upgrading from 5.x: under a third as long (15,300 → 4,300 words), grouped by what a reader needs rather than by the order the work was done.

  • New layout:
    • Headlines, each linking to its details.
    • Upgrading from 5.x, by area.
    • Output that differs from 5.x, for anyone comparing files with ones 5.x wrote.
    • New features, led by summaries of VCF and BCF versions, indexing (a table of the index each format writes and reads) and bgzipped SAM.
    • Deprecations.
    • Performance against 5.0.2.
    • Bug fixes by area.
  • Bug fixes are one line each, with issue links (reference-style) for the detail. Build and testing notes are dropped.
  • Added the user-visible changes the section missed:
    • DiskBackedQueue no longer cleans up on garbage collection.
    • Java-serialized VCF objects from 5.x don't deserialize.
    • The BCF writer refuses a custom IndexCreator.
    • SAMUtils overlap clipping.
    • Several CRAM fixes.
    • Faster SAM parsing.
    • Runtime dependency updates.
  • Removed entries describing fixes of bugs no release had.
  • The performance table is new: a mirrored A/B of this master against 5.0.2.
  • Checked by three reviews:
    • completeness against all 148 commits since 5.0.0 (Opus);
    • every statement against the code and the 5.0.0 source (Opus);
    • a list of every fact the old text had that this one cuts (Fable). Its 14 restore items are back in.
  • 5.0.2 and earlier sections are unchanged.

The 6.0.0 section had grown to about 15,000 words in the order the work
was done. It is now about a third as long and grouped for a reader
upgrading from 5.x: headlines; what to change when upgrading, by area;
output that differs from 5.x, for anyone comparing files with ones 5.x
wrote; new features; deprecations; performance against 5.0.2; and bug
fixes by area, one line each, with issue links for the detail. The
build and testing notes are dropped.

Entries are added for user-visible changes the section missed
(DiskBackedQueue no longer cleans up on garbage collection, Java
serialization of 5.x VCF objects, the BCF writer refusing a custom
IndexCreator, SAMUtils overlap clipping, several CRAM fixes, faster SAM
parsing, the runtime dependency updates), and entries describing fixes
of bugs no release had are removed.
@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Files selected but had no reviewable changes: 1
  • CHANGELOG.md
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 828951f7-ffb5-46cd-a4a2-73cc7bffa7b9
Commits

Reviewing files that changed from the base of the PR and between e7dff38 and d7f6063.

Files selected for processing: 1
  • CHANGELOG.md

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

…ipped SAM

Each headline now links to its section. Indexing leads with a table of
the index each format writes and reads, then a few short bullets and two
paragraphs; VCF and BCF versions lead with a table of what is read and
written; bgzipped SAM has its own short section. Index-related upgrade
notes are gathered under one heading, and the longer upgrade bullets are
shortened.
@tfenne
tfenne merged commit 0d106fb into master Oct 26, 2026
4 checks passed
@tfenne
tfenne deleted the tf_changelog_6_0_rewrite branch October 26, 2026 19:00
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