Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: correct README.md parsing without an existing Usage h2 #2143

Merged
merged 1 commit into from
Apr 4, 2025

Conversation

JoshuaKGoldberg
Copy link
Owner

PR Checklist

Overview

https://github.com/JoshuaKGoldberg/prune-github-notifications didn't have a ## Usage in its README.md, and instead of allowing all content until the next relevant h2 or end-of-file, the option was defaulting to undefined.

This reminds me that blockREADME hardcodes a ## Usage in there - that's not an assumption I want to keep. But removing that assumption can be a followup.

🎁

Copy link

codecov bot commented Apr 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.81%. Comparing base (c0fa41b) to head (95df083).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2143   +/-   ##
=======================================
  Coverage   99.81%   99.81%           
=======================================
  Files         129      129           
  Lines        5461     5475   +14     
  Branches      395      399    +4     
=======================================
+ Hits         5451     5465   +14     
  Misses         10       10           

☔ 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.

@JoshuaKGoldberg JoshuaKGoldberg merged commit 79cd25f into main Apr 4, 2025
14 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the readme-explainer-no-usage branch April 4, 2025 12:55
Copy link

github-actions bot commented Apr 4, 2025

🎉 This is included in version v2.26.7 🎉

The release is available on:

Cheers! 📦🚀

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.

🐛 Bug: Transition mode clobbers existing README.md content after badges if there is no Usage h2
1 participant