Skip to content

chore(release): concise changelog lines with primitive tags - #88

Open
rpvilo wants to merge 1 commit into
mainfrom
feature/concise-release-notes
Open

rpvilo wants to merge 1 commit into
mainfrom
feature/concise-release-notes

Conversation

@rpvilo

@rpvilo rpvilo commented Oct 11, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • .changeset/changelog.cjs replaces @changesets/changelog-github: a release line is the changeset text alone, with no PR link, commit hash or credit. GitHub Releases copy the same text.
  • .changeset/README.md (linked from AGENTS.md) sets the format: one line per change, led by a [Primitive] tag; a breaking change adds [Breaking] and a one-sentence migration. Before 1.0 a breaking change ships as a minor bump, so the tag is what marks it.
  • packages/chat/CHANGELOG.md is rewritten from 0.1.0 to 0.5.2 in that format.
  • The changelog page turns the leading tags into badges with a coloured dot per primitive (lib/docs/remark-changelog-tags.ts). Breaking is red; an unmapped tag gets a grey dot.

Release

No new npm version: the changeset is empty, and CHANGELOG.md is not in the published files.

Follow-up

The GitHub Releases for 0.1.1–0.5.2 still carry the old notes.

Summary by CodeRabbit

  • New Features

    • Changelog entries with leading tags now display those tags as badges.
  • Documentation

    • Historical release notes are now more concise, while retaining release changes and breaking-change notices.
    • Changelog guidance now explains how to format user-facing summaries, mark breaking changes, and use tags.

@vercel

vercel Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
intentface-chat Ready Ready Preview Oct 11, 2026 8:53pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: e789cbc3-4e55-45af-828f-4659d2207348

📥 Commits

Reviewing files that changed from the base of the PR and between adf6d52 and 829fe44.


⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock

📒 Files selected for processing (10)
  • .changeset/README.md
  • .changeset/changelog.cjs
  • .changeset/config.json
  • .changeset/forty-symbols-dream.md
  • AGENTS.md
  • content/docs/changelog.mdx
  • lib/docs/remark-changelog-tags.ts
  • package.json
  • packages/chat/CHANGELOG.md
  • source.config.ts

💤 Files with no reviewable changes (1)
  • package.json

Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


📜 Recent review details
⏰ Context from checks skipped due to timeout. (3)
  • GitHub Check: Analyze (actions)
  • GitHub Check: verify
  • GitHub Check: Analyze (javascript-typescript)

🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: Intentface/intentface-chat

Timestamp: 2026-10-11T20:53:53.805Z
Learning: Source excerpt:
# AGENTS.md

### Component Architecture

#### Package layer — `packages/chat/`

A change to the package needs a changeset, and a changeset is one short line per change, not a write-up: see [`.changeset/README.md`](./.changeset/README.md). The reasoning goes in the PR body.

🔇 Additional comments (6)
.changeset/README.md (1)

14-32: LGTM!


AGENTS.md (1)

82-83: LGTM!


.changeset/changelog.cjs (1)

1-10: LGTM!


.changeset/config.json (1)

3-3: LGTM!


.changeset/forty-symbols-dream.md (1)

1-2: LGTM!


source.config.ts (1)

19-19: 🎯 Functional Correctness

Fumadocs runs remarkInclude before configured remark plugins. The included changelog items therefore reach remarkChangelogTags in the content/docs/changelog.mdx tree. No ordering change is needed.



📝 Walkthrough

Walkthrough

Changesets now use a local release-line formatter. The documentation build renders leading tags in changelog entries as badges. Existing package release notes are condensed.

Changes

Changelog workflow

Layer / File(s) Summary
Changeset formatting and authoring
.changeset/README.md, AGENTS.md, .changeset/changelog.cjs, .changeset/config.json, package.json, .changeset/forty-symbols-dream.md
Adds changeset-writing guidance and a local formatter that trims summaries and ensures they start with - . Changesets configuration uses the local formatter, and the GitHub changelog dependency is removed.
Changelog tag rendering
lib/docs/remark-changelog-tags.ts, source.config.ts, content/docs/changelog.mdx
Registers a remark plugin that converts leading tags in changelog list items into badges. The changelog documentation describes the tag syntax.
Existing release-note summaries
packages/chat/CHANGELOG.md
Condenses release notes from versions 0.1.0 through 0.5.2 while retaining listed changes and breaking-change notes.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Other


Merge Risk: ⚪ Minimal · up to 829fe

The historical notes follow the tag exception, and included notes reach the badge renderer. The change is mergeable after normal checks.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main changes: concise changelog lines and primitive tags.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 3…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR


🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

This branch was successfully deployed

1 active deployment
Preview — 829fe442 Deployed Oct 11, 2026 by vercel[bot]
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.

1 participant