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: Migration script re-adds end of README.md notice #843

Closed
3 tasks done
JoshuaKGoldberg opened this issue Sep 19, 2023 · 1 comment · Fixed by #845
Closed
3 tasks done

🐛 Bug: Migration script re-adds end of README.md notice #843

JoshuaKGoldberg opened this issue Sep 19, 2023 · 1 comment · Fixed by #845
Assignees
@JoshuaKGoldberg
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Milestone
Post-Rename Migra...

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

#129 shouldn't be re-occurring during --mode migrate.

Actual

I'm finding that README.mds are actually getting the notice repeatedly. I think it's that updateReadme is always adding the notice, even if it doesn't have to.


<!-- You can remove this notice if you don't want it 🙂 no worries! -->

> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).

<!-- You can remove this notice if you don't want it 🙂 no worries! -->

> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [testing-hello](https://github.com/JoshuaKGoldberg/testing-hello).

<!-- You can remove this notice if you don't want it 🙂 no worries! -->

> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [testing-hello](https://github.com/JoshuaKGoldberg/testing-hello).

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working :( status: accepting prs Please, send a pull request to resolve this! labels Sep 19, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Post-Rename Migration milestone Sep 19, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Sep 19, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Sep 19, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Sep 19, 2023
@JoshuaKGoldberg
fix: only append README.md notice if it doesn't yet exist (#845)
67612d7 
## PR Checklist

- [x] Addresses an existing open issue: fixes #843
- [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

Uses the `<!-- ... -->` line as a detector to know whether to append.

Note that _creation_ was fixed previously, just not _appending_
(updating).
@github-actions
Copy link

🎉 This is included in version v1.29.46 🎉

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
Post-Rename Migration
Development

Successfully merging a pull request may close this issue.

fix: only append README.md notice if it doesn't yet exist JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg