Skip to content

1.5.1: Fix GitHub release notes newline rendering + package metadata/dependency updates

Choose a tag to compare

@tobrien tobrien released this 28 Jan 02:06
· 9 commits to working since this release
a4ebd2c

Summary

Version 1.5.1 is a small patch release focused on improving the reliability of GitHub release creation (specifically how release notes render on GitHub), along with minor package metadata/dependency updates.

Fixed: Properly render release notes when content contains escaped newlines

When creating a GitHub release via createRelease(tagName, title, notes), release notes (and sometimes titles) can end up containing escaped newline sequences (literal , , ) if they were produced by AI tooling or passed through JSON serialization layers.

Change: createRelease now normalizes these sequences before sending them to the GitHub API:

  • Converts \ → actual newline
  • Converts \ → carriage return
  • Converts \ → tab

Why it matters: GitHub will now display release notes with proper line breaks instead of showing raw text, which makes generated release notes readable without manual cleanup.

Package updates

  • Set package version to 1.5.1.
  • Updated package metadata/dependency constraints (notably aligning the @grunnverk/git-tools dependency to ^1.5.1).

Breaking changes

No breaking changes were detected in this release.