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.

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

🛠 Tooling: Migration end-to-end test should use --guide and --guide-title #1091

Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 11, 2023 · 2 comments
Closed
3 tasks done
Labels
area: tooling Managing the repository's maintenance good first issue Good for newcomers, please hop on! status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups

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 optional --guide and --guide-title options were added in #982 -> #983. They add a little text blurb to the top of DEVELOPMENT.md:

> If you'd like a more guided walkthrough, see [Contributing to a create-typescript-app Repository](https://www.joshuakgoldberg.com/blog/contributing-to-a-create-typescript-app-repository).
> It'll walk you through the common activities you'll need to contribute.

But, the end-to-end migration test isn't running with them:

})`c8 -o ./coverage-migrate -r html -r lcov --src src node ./bin/index.js --base everything --mode migrate --description ${description} --email-github ${emailGithub} --email-npm ${emailNpm} --owner ${owner} --title ${title} --repository ${repository} --skip-all-contributors-api --skip-github-api --skip-install`;

Let's add --guide and --guide-title to the end-to-end test's command. That way the generated .github/DEVELOPMENT.md will also have the guided walkthrough notice.

Additional Info

This repository is two things:

  • 🍎 An example of a working TypeScript repository, including builds, Knip, package publishing, and more tooling
  • 🍌 Code that can set up a new or existing repository using all of that repository tooling

For the most part, the repository's end-to-end test for --mode migration makes sure that the 🍎 actual files and 🍌 code templates stay the same. As in, if one changes, the other needs to have the same change as well. But per #546, there are some files that were missed in that test. We're only now able to verify that they're the same as of #1048. That PR is where this discrepancy was discovered.

@JoshuaKGoldberg JoshuaKGoldberg added good first issue Good for newcomers, please hop on! area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups labels Dec 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Simpler Snapshots milestone Jan 9, 2024
@DemianParkhomenko
Copy link
Contributor

Seems closed by 2f8e90f

@JoshuaKGoldberg
Copy link
Owner Author

Ha, #1135 was a dup of this one. Thanks! 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: tooling Managing the repository's maintenance good first issue Good for newcomers, please hop on! status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups
Projects
None yet
Development

No branches or pull requests

2 participants