chore: stop gitignoring plugin CHANGELOG.md files - #1519
Merged
Conversation
The blanket `*.md` rule (added in #811) had no negation for `CHANGELOG.md`, so every plugin added after 2025-11-14 had its generated CHANGELOG silently dropped by `git add` during the release commit. This cascaded into two release-side bugs: 1. `changesets/action`'s `createRelease` reads `CHANGELOG.md` from disk to build the GitHub release body. For untracked plugins it hits ENOENT and silently returns, so no GitHub release ever gets created (npm releases still go out fine). 2. When a PR's changeset is scoped only to a plugin (e.g. #1219 → `@livekit/agents-plugin-assemblyai`), the descriptive entry only lives in that plugin's CHANGELOG. With the file gitignored, the description never reaches `main`, and `agents/CHANGELOG.md` is left with just the "Updated dependencies" line from the fixed- group bump — so the PR shows up nowhere in the release notes. Affected plugins (added after the rule landed): assemblyai, baseten, cerebras, fishaudio, hedra, hume, inworld, lemonslice, liveavatar, minimax, mistral, mistralai, phonic, runway, sarvam, trugen, xai. Adding `!**/CHANGELOG.md` lets the next `Version Packages` PR commit the regenerated CHANGELOG files for these plugins so they get GitHub releases and full release-note attribution from the next cycle on. Co-authored-by: Cursor <cursoragent@cursor.com>
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
bcherry
approved these changes
May 15, 2026
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
2 participants
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
The blanket
*.mdrule in.gitignore(added in #811 on 2025-11-14) has no negation forCHANGELOG.md. Plugins that already existed when the rule landed had theirCHANGELOG.mdtracked at the time, so git keeps updating those files. Every plugin added after 2025-11-14 has its generatedCHANGELOG.mdsilently dropped bygit addduring the release commit.This cascades into two release-side bugs:
changesets/action'screateReleasereadsCHANGELOG.mdfrom disk to build the GitHub release body. For untracked plugins it hitsENOENTand silently returns — npm publish still goes out, but no GitHub release ever appears.@livekit/agentslose attribution. When a PR's changeset is scoped only to a plugin (e.g. feat(assemblyai): new STT plugin for Universal-Streaming (v3) #1219 →@livekit/agents-plugin-assemblyai), the descriptive entry only lives in that plugin's CHANGELOG. With the file gitignored, the description never reachesmain, andagents/CHANGELOG.mdonly gets the bare "Updated dependencies" line from the fixed-group bump — so the PR shows up nowhere in the published release notes. That's why feat(assemblyai): new STT plugin for Universal-Streaming (v3) #1219 is missing from the@livekit/agents@1.2.7release notes even though it's listed in the version-packages PR (Version Packages #1233).Affected plugins (added after the rule landed):
assemblyai,baseten,cerebras,fishaudio,hedra,hume,inworld,lemonslice,liveavatar,minimax,mistral,mistralai,phonic,runway,sarvam,trugen,xai.Fix
Add
!**/CHANGELOG.mdto.gitignore. From the next `Version Packages` PR onward, the regenerated CHANGELOG files for these plugins will actually be committed, giving them GitHub releases and proper release-note attribution.Note on backfill
Historical 1.2.x–1.4.x GitHub releases for the affected plugins won't be created retroactively by this fix — the original
.changeset/*.mdsource files for those versions were already consumed. If the docs scraper needs them, we'd have to reconstruct entries from PR titles + commit history and create the releases via the GitHub API in a separate pass.Test plan
Version Packagescommit on `main` includes new `plugins//CHANGELOG.md` files.Made with Cursor