Skip to content

vendor/wheels/ does not ship CHANGELOG.md or release notes — consumers can't look up referenced PRs without leaving the codebase #2719

@bpamiri

Description

@bpamiri

Severity: docs / discoverability.

Surfaced by: titan Phase 2.4 (Wheels 4.0 upgrade), 2026-05-15.

Description

An upgrader reading _upgrade-docs/PLAN.md or the canonical 3.x→4.0 upgrade guide will encounter PR references like "introduced in #1930" or "per #1985". To understand what those PRs actually changed, they have to:

  1. Leave their codebase
  2. Navigate to github.com/wheels-dev/wheels/pull/
  3. Read the PR description

vendor/wheels/ (the bundled framework checkout titan and other 4.0 apps ship) has no CHANGELOG.md, no RELEASE-NOTES.md, and no equivalent in-tree reference. The vendor/wheels/box.json only shows the version (e.g. 4.0.0-SNAPSHOT+1779) — not what's in it.

Suggested fix

Ship a CHANGELOG.md (or RELEASE-NOTES.md) inside vendor/wheels/ at release time. The Wheels 4.0 GA snapshot already has the full PR list — it just needs to land alongside the framework files. Ideally one entry per PR with a one-line summary and a link back to the GitHub URL.

Consumers doing offline / no-internet upgrade work would also benefit.

cc @bpamiri

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions