Skip to content

[major] Clean up the 1.0.0 changelog before un-drafting the release (duplicate entries, broken compare link, truncated breaking-change note) #135

Description

@lens0021

Problem

The generated 1.0.0 changelog (release-please PR #30, chore(main): release 1.0.0) — which becomes the body of the first stable GitHub Release — has three defects that should be fixed before the release is un-drafted. Note line numbers below are approximate: release-please regenerates the file, so locate by text.

1. Every change is listed twice (major)

Most features/fixes appear once as a bare commit-hash entry and once as a PR-number entry (~39 duplicate pairs across Features and Bugfixes), because earlier history was merged with both merge-commits and squash commits. Confirmed duplicates include: add a "View source" tab, add a configurable header logo and the Wikven brand mark, add a footer skin switcher, distribute a standalone binary, support local images, upgrade to MediaWiki 1.45. PR #131 (merge PRs by squash to stop release-please duplicates, merged) fixes only future releases; the accumulated 1.0.0 history is already duplicated.

2. Compare link points to a tag that never existed (minor)

The header reads ## [1.0.0](https://github.com/chaotic-ground/wikven/compare/v0.1.0...v1.0.0). But git tag -l 'v*' is empty and gh release view v0.1.0 returns release not found.release-please-manifest.json was bootstrapped to 0.1.0 without ever cutting a tag (only nightly-* pre-releases exist). The link 404s / shows unrelated histories.

3. A breaking-change note is cut off mid-sentence (minor)

Under ### ⚠ BREAKING CHANGES:

* the "WikvenLogo: <file>" config key is replaced by a

The sentence stops at replaced by a. The source commit (0bde57a) footer wrapped to a second physical line ("WikvenLogos: { icon: <file>, ... }" map.) that release-please did not capture, so the most important section of the release notes tells the upgrading user nothing about the replacement.

Suggested fix

Before un-drafting 1.0.0, hand-edit CHANGELOG.md on the release-please branch (and/or override the release notes body) to: (a) collapse each duplicate pair to the PR-number entry, (b) complete the breaking-change sentence (WikvenLogos/$wgLogos map), and (c) repoint or drop the broken v0.1.0 compare link (set release-please last-release-sha/bootstrap-sha, or create a retroactive v0.1.0 tag). Verify the compare link resolves. The squash-only policy from #131 keeps future changelogs clean.


Filed from an adversarial v1.0.0 readiness review. Dimension: release-distribution. Severity: major.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions