Skip to content

Fix doc typos, add changelog formatter for GitHub releases - #50

Merged
theoephraim merged 3 commits into
mainfrom
docs/typos-and-fixes
Apr 25, 2026
Merged

theoephraim merged 3 commits into
mainfrom
docs/typos-and-fixes

Conversation

@theoephraim

@theoephraim theoephraim commented Apr 24, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Fix GitHub releases having no body content — previously, GitHub releases used a basic fallback that produced minimal output. Now the configured changelog formatter is used for GitHub release bodies too, with a new target context field so formatters can customize output per target (e.g., omit date headings for GitHub releases since the release already has a timestamp).
  • Fix typos across docs: "additonal", "Oending", "settting", awkward phrasing in cli.md
  • Change bun test to bun run test in README development section
  • Add "claude" to AI setup targets in CLI help text (was missing despite being a valid target)

Test plan

  • Verify GitHub releases use the changelog formatter and include full content
  • Verify docs read correctly with no typos
  • Run bunx bumpy --help and confirm claude appears in AI setup targets

- 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
@bumpy-bot

Copy link
Copy Markdown
Collaborator

bumpy-frog

The changes in this PR will be included in the next version bump.

patch Patch releases

  • @varlock/bumpy 1.2.2 → 1.2.3

Bump files in this PR

Click here if you want to add another bump file to this PR


This comment is maintained by bumpy.

@theoephraim theoephraim changed the title Fix doc typos and add changelog formatter target for GitHub releases Fix doc typos, add changelog formatter for GitHub releases Apr 24, 2026
@theoephraim
theoephraim merged commit 2e88cbc into main Apr 25, 2026
2 checks passed
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.
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.

2 participants