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: Don't remove template docs in updateLocalFiles in --mode migrate #1220

Closed
3 tasks done
JoshuaKGoldberg opened this issue Jan 9, 2024 · 1 comment · Fixed by #1223
Closed
3 tasks done

🐛 Bug: Don't remove template docs in updateLocalFiles in --mode migrate #1220

JoshuaKGoldberg opened this issue Jan 9, 2024 · 1 comment · Fixed by #1223
Labels
type: bug Something isn't working :(

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

If an existing repository is being run with --mode migrate, then the replacements in updateLocalFiles shouldn't remove existing lines like test:create or ## Setup Scripts. The repository might have coincidentally had them!

Actual

updateLocalFiles applies those replacements no matter what.

Additional Info

Following up on #1167 -> #1173: we don't want to remove the ## Setup Scripts part of .github/DEVELOPMENT.md in migration. Just in create & initialize.
@JoshuaKGoldberg JoshuaKGoldberg added the type: bug Something isn't working :( label Jan 9, 2024
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Jan 9, 2024
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Jan 9, 2024
@JoshuaKGoldberg
fix: skip replacing existing tooling in --mode migrate (#1223)
c4025fa 
## PR Checklist

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

Gates those elements of `replacements` behind `options.mode` not being
`"migrate"`. Which means the end-to-end migration snapshot for
`.github/DEVELOPMENT.md` no longer shows removing `## Setup Scripts`!
Yay!
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Jan 9, 2024
Closed
3 tasks
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.54.0 🎉

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
No one assigned
Labels
type: bug Something isn't working :(
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: skip replacing existing tooling in --mode migrate JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg