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

🚀 Feature: In --mode migrate, preserve existing .github/DEVELOPMENT.md body contents #1167

Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 31, 2023 · 1 comment · Fixed by #1173
Closed
3 tasks done

🚀 Feature: In --mode migrate, preserve existing .github/DEVELOPMENT.md body contents #1167

JoshuaKGoldberg opened this issue Dec 31, 2023 · 1 comment · Fixed by #1173
Assignees
@JoshuaKGoldberg
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

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.

Overview

The end-to-end migration test snapshot intentionally adds back in .github/DEVELOPMENT.md content to account for it being removed during migration:

create-typescript-app/script/migrate-test-e2e.js

Lines 64 to 70 in 8244e06

// The development setup scripts docs can be ignored from snapshots.
// We manually add them back after hydration to clear them from Git diffs.
await fs.appendFile(
".github/DEVELOPMENT.md",
"\n" +
originalDevelopment.slice(originalDevelopment.indexOf("## Setup Scripts")),
);

My idea there was that existing development docs from a repo are likely no longer relevant once it's migrated to create-typescript-app's template... but create-typescript-app itself is a counter-example!

Let's keep existing content such as what's in this repo. It can be placed after a \n\n---\n\n.

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Dec 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Jan 1, 2024
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Jan 9, 2024
@JoshuaKGoldberg
feat: preserve existing unknown .github/DEVELOPMENT.md sections (#1173)
5cd4a95 
## PR Checklist

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

Now, when `.github/DEVELOPMENT.md` exists, any `##` that doesn't match
the new headings will be preserved and moved to the bottom of the file.

Note that this doesn't show up nicely in the migration test end-to-end
snapshots because `updateLocalFiles` manually removes the `## Setup
Scripts` sections.
@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

@JoshuaKGoldberg JoshuaKGoldberg

Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
Milestone
No milestone
1 participant
@JoshuaKGoldberg