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

🛠 Tooling: Filter out noisy areas from end-to-end migration test snapshots #1142

Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 30, 2023 · 2 comments · Fixed by #1146 or #1148
Closed
3 tasks done

🛠 Tooling: Filter out noisy areas from end-to-end migration test snapshots #1142

JoshuaKGoldberg opened this issue Dec 30, 2023 · 2 comments · Fixed by #1146 or #1148
Assignees
@JoshuaKGoldberg
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this!

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

Splitting out #1048 (comment):

There are a few files in the snapshots that have a lot of changed lines:

  • .all-contributorsrc: all the contributors being changed _(though that might go away if we figure out formatting things)
  • .github/DEVELOPMENT.md: all the content under ## Setup Scripts
  • README.md: everything after the top content up until ## Development

It'd be nice if those large diffs were excluded from the snapshot. I don't think we'd want to have to also change the snapshots every time a contributor gets added or the setup script docs / main README docs change.

I'll add that filtering logic now.

Additional Info

This is blocking any PR that updates .all-contributorsrc. Including #1139, which credits @Aslemammad for code contribution. Amusing irony.
@JoshuaKGoldberg JoshuaKGoldberg added area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! labels Dec 30, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 30, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 30, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Dec 30, 2023
@JoshuaKGoldberg
chore: transform noisy files in e2e migration test (#1146)
b12dcc1 
## PR Checklist

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

In the migration script, after running with `--mode migrate` but before
running test assertions, modifies a couple of files on disk:

1. `.all-contributorsrc`: Formats with `JSON.stringify(..., null, 2)` as
it seems All Contributors isn't able to use Prettier for it
2. `.github/DEVELOPMENT.md`: Adds back in the `## The Setup Scripts`
heading, as it's not part of the default template

Also wraps the `test`s in `describe` and standardizes naming just a bit.
I'm very nitpicky.
@JoshuaKGoldberg
Copy link
Owner Author

This is still a thing. See the glorious commit history from #1139.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 30, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Dec 30, 2023
@JoshuaKGoldberg
chore: more e2e migration snapshots filters: contributors and line nu…
ab36a22 
…mbers (#1148)

## PR Checklist

- [x] Addresses an existing open issue: fixes #1142 (again)
- [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

Resets the all-contributors count in the snapshot too. So there's much
less diff noise around it.

In doing so, indicates that the snapshot file _might_ be changed. ANd
that's ok.
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.50.2 🎉

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
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Milestone
No milestone
1 participant
@JoshuaKGoldberg