Skip to content

🐛 Bug: In --mode migrate, preserve existing README.md paragraph after logo and before the first h2 #1159

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
Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 31, 2023 · 2 comments · Fixed by #1609
Closed
3 tasks done

🐛 Bug: In --mode migrate, preserve existing README.md paragraph after logo and before the first h2 #1159

JoshuaKGoldberg opened this issue Dec 31, 2023 · 2 comments · Fixed by #1609
Assignees
@JoshuaKGoldberg
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Milestone
Simpler Snapshots

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Dec 31, 2023 •
edited
Loading

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.

Overview

The end-to-end migration test snapshot file shows a bunch of README.md content removed:

create-typescript-app/script/__snapshots__/migrate-test-e2e.ts.snap

Lines 39 to 51 in a10362c

exports[`expected file changes > README.md 1`] = `
"--- a/README.md
+++ b/README.md
@@ ... @@
<img align="right" alt="Project logo: the TypeScript blue square with rounded corners, but a plus sign instead of 'TS'" src="./docs/create-typescript-app.png">
-\`create-typescript-app\` is a one-stop-shop solution to set up a new or existing repository with the latest and greatest TypeScript tooling.
-It includes options not just for building and testing but also GitHub repository templates, contributor recognition, automated release management, and more.
-
## Getting Started
First make sure you have the following installed:

Additional Info

GitHub dropped some of the issue body the first time I filed this issue. Ugh. But I recorded it! https://twitter.com/JoshuaKGoldberg/status/1741572622050103344

Screen.Recording.2023-12-31.at.4.23.34.PM.mov
@JoshuaKGoldberg JoshuaKGoldberg added the area: tooling Managing the repository's maintenance label Dec 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg added the status: accepting prs Please, send a pull request to resolve this! label Dec 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🛠 Tooling: In --mode migrate, preserve existing .github/DEVELOPMENT.md body contents 🚀 Feature: In --mode migrate, preserve existing .github/DEVELOPMENT.md body contents Dec 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request and removed area: tooling Managing the repository's maintenance labels Dec 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🚀 Feature: In --mode migrate, preserve existing .github/DEVELOPMENT.md body contents 🚀 Feature: In --mode migrate, preserve existing README.md body contents Dec 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Simpler Snapshots milestone Jan 9, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🚀 Feature: In --mode migrate, preserve existing README.md body contents 🐛 Bug: In --mode migrate, preserve existing README.md body contents Aug 11, 2024
@JoshuaKGoldberg
Copy link
Owner Author

Looking at this now. I think this is actually a bug, that the first paragraph isn't preserved.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Aug 11, 2024
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🐛 Bug: In --mode migrate, preserve existing README.md body contents 🐛 Bug: In --mode migrate, preserve existing README.md paragraph after logo and before the first h2 Aug 11, 2024
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.67.1 🎉

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: feature New enhancement or request
Projects
None yet
Milestone
Simpler Snapshots
Development

Successfully merging a pull request may close this issue.

fix: preserve post-badge paragraph in README.md migration JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg