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.

Sign up for GitHub

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

Jump to bottom

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

Closed
3 tasks done
JoshuaKGoldberg opened this issue Apr 4, 2025 · 1 comment · Fixed by #2143
Closed
3 tasks done

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

JoshuaKGoldberg opened this issue Apr 4, 2025 · 1 comment · Fixed by #2143
Assignees
@JoshuaKGoldberg
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Milestone
Transition Mode D...

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Expected

Following #2127 -> #2128, running npx create-typescript-app in an existing repo shouldn't remove any content between badges and ## Usage.

Actual

https://github.com/JoshuaKGoldberg/prune-github-notifications/pull/201/files#r2028676849 shows sections being removed. Again. Ugh.

Additional Info

🎁
@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :( labels Apr 4, 2025
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Apr 4, 2025
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🐛 Bug: Transition mode clobbers existing heading between badges and Usage again 🐛 Bug: Transition mode clobbers existing README.md content after badges if there is no Usage Apr 4, 2025
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🐛 Bug: Transition mode clobbers existing README.md content after badges if there is no Usage 🐛 Bug: Transition mode clobbers existing README.md content after badges if there is no Usage h2 Apr 4, 2025
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Apr 4, 2025
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Apr 4, 2025
@JoshuaKGoldberg
fix: correct README.md parsing without an existing Usage h2 (#2143)
79cd25f 
## PR Checklist

- [x] Addresses an existing open issue: fixes #2140
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

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

🎁
@github-actions GitHub Actions
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
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Projects
None yet
Milestone
Transition Mode Dogfooding
Development

Successfully merging a pull request may close this issue.

fix: correct README.md parsing without an existing Usage h2 JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg