Repository navigation
Fix doc typos, add changelog formatter for GitHub releases - #50
Merged
Merged
Conversation
- Fix "additonal" → "additional" in README - Fix "Oending" → "Pending" in README - Fix "settting" → "setting" in changelog-formatters.md - Fix awkward "or, (or just" phrasing in cli.md - Change `bun test` → `bun run test` in README dev section - Add "claude" to AI setup targets in CLI help text - Add `target` field to changelog formatter context for GitHub releases - Use changelog formatter for GitHub release bodies
Collaborator
|
The changes in this PR will be included in the next version bump.
|
theoephraim
added a commit
that referenced
this pull request
Jun 18, 2026
## Problem Both changelog formatters always jammed the entry description onto the same line as the metadata, e.g. `- #50 (major) Thanks @Saeris! - <summary>`. That reads fine for a short one-liner, but badly when the summary is markdown or long (see [discordkit's CHANGELOG](https://github.com/discordkit/discordkit/blob/main/packages/core/CHANGELOG.md)). ## Change Added a shared heuristic `summaryNeedsBlockLayout()` that switches an entry to a **block layout** — metadata on its own line, summary indented below — when the summary is any of: - **multi-line** (>1 non-empty line), - **long** (first line >120 chars), or - **markdown-ish** — contains a block-level construct (`#` heading, list item, `>` blockquote, ` ``` `/`~~~` fence, table row), anchored to line starts so a stray `|` in prose doesn't trigger it. Short single-line summaries stay inline exactly as before. The block path also now **preserves internal blank lines** so markdown paragraphs/lists render correctly. Applied to both the default and `github` formatters. ``` - *(minor)* Added a new flag to the CLI ← short stays inline - [#50](…) *(major)* Thanks [@Saeris](…)! ← markdown/long/multiline → block ## New config option You can now set `foo` in your config ``` Thresholds live as single constants (`INLINE_SUMMARY_MAX_LENGTH`, `MARKDOWN_BLOCK_RE`) in `changelog.ts`. ## Tests - Full suite: 309 pass / 0 fail. - Added inline / long / markdown / multi-paragraph cases for both formatters; updated the one existing test that asserted the old inline-multiline behavior. - `oxlint` + `tsc --noEmit` clean.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Summary
targetcontext field so formatters can customize output per target (e.g., omit date headings for GitHub releases since the release already has a timestamp).bun testtobun run testin README development sectionTest plan
bunx bumpy --helpand confirmclaudeappears in AI setup targets