Skip to content

fix(@changesets/read): ignore uppercase .md files in .changeset dir#1912

Open
mixelburg wants to merge 2 commits into
changesets:mainfrom
mixelburg:fix/ignore-uppercase-md-files-in-changeset-dir
Open

fix(@changesets/read): ignore uppercase .md files in .changeset dir#1912
mixelburg wants to merge 2 commits into
changesets:mainfrom
mixelburg:fix/ignore-uppercase-md-files-in-changeset-dir

Conversation

@mixelburg
Copy link
Copy Markdown
Contributor

Fixes #1906

Currently any .md file in .changeset/ that isn't README.md gets parsed as a changeset. This causes a cryptic parse error when you put docs like AGENTS.md or CLAUDE.md in there:

Error: could not parse changeset - invalid frontmatter: Read AGENTS.md for project knowledge.

The fix extends the existing README.md exclusion to cover all uppercase-starting filenames. The convention is already established (README.md) and natural — changeset IDs are always lowercase adjective-noun pairs.

Changed !/^README\.md$/i.test(file) to !/^[A-Z]/.test(file), so AGENTS.md, CLAUDE.md, CONTRIBUTING.md, etc. are all silently skipped.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 30, 2026

🦋 Changeset detected

Latest commit: f22b1eb

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

This PR includes changesets to release 4 packages
Name Type
@changesets/read Patch
@changesets/cli Patch
@changesets/get-release-plan Patch
@changesets/release-utils Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.22%. Comparing base (5c4731f) to head (f22b1eb).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1912      +/-   ##
==========================================
- Coverage   83.23%   83.22%   -0.02%     
==========================================
  Files          56       56              
  Lines        2434     2432       -2     
  Branches      734      731       -3     
==========================================
- Hits         2026     2024       -2     
  Misses        402      402              
  Partials        6        6              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Andarist
Copy link
Copy Markdown
Member

I dont think its worth generalizing the rule right now. I’d just prefer maintaining an explicit allowlist - i dont expect it would really have that many entries

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.

[FEAT]: Allow ignoring non-changeset .md files in .changeset/ DIR

2 participants