Skip to content

Commit c66fdda

Browse files
docs: mention end-to-end test debugging for migration scripts (#833)
## PR Checklist - [x] Addresses an existing open issue: fixes #832 - [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 Mentions the steps I found necessary in `.github/DEVELOPMENT.md`.
1 parent 597f186 commit c66fdda

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

.github/DEVELOPMENT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,3 +194,7 @@ That end-to-end test executes `script/migrate-test-e2e.js`, which:
194194

195195
The `pnpm run test:migrate` script is run in CI to ensure that templating changes are in sync with the template's actual files.
196196
See `.github/workflows/test-migrate.yml`.
197+
198+
> Tip: if the migration test is failing in CI and you don't see any errors, try [downloading the full logs](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs#downloading-logs).
199+
> There'll likely be a list of changed files under a message like _`Oh no! Running the migrate script modified some files:`_.
200+
> You can also try running the test script locally.

0 commit comments

Comments
 (0)