-
Notifications
You must be signed in to change notification settings - Fork 0
Document that the e2e suite can and must be run locally or watched in CI #36
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,42 @@ | ||
| # Claude Scripts | ||
| # Running the tests | ||
|
|
||
| `run-e2e-tests.sh` - Idempotent script that installs gh, gets a cached GitHub App token, and runs e2e tests | ||
| You CAN run every test in this repo yourself. Do not claim a test is | ||
| "left to CI" or "can't be run locally" — that is false here. | ||
|
|
||
| ## Offline unit tests (instant, no credentials) | ||
|
|
||
| ```bash | ||
| bash tests/test_update_pr_stack.sh | ||
| bash tests/test_rebase_workflow.sh | ||
| bash tests/test_mixed_workflows.sh | ||
| ``` | ||
|
|
||
| ## Full end-to-end test (real GitHub, several minutes) | ||
|
|
||
| ```bash | ||
| bash .claude/run-e2e-tests.sh | ||
| ``` | ||
|
|
||
| This is self-contained: direnv supplies the GitHub App credentials, the script | ||
| installs `gh` if missing, mints a short-lived token, then runs `tests/test_e2e.sh`, | ||
| which creates and tears down a throwaway public repo under the `autorestack-test` | ||
| org and waits on real GitHub Actions runs. It tests the currently checked-out | ||
| HEAD commit, so commit (and usually push, so the workflow can reference the | ||
| action at that commit) before running. It is long, so run it in the background. | ||
|
|
||
| ## You must validate e2e changes, one way or the other | ||
|
|
||
| A change that touches `tests/test_e2e.sh`, `update-pr-stack.sh`, or the action | ||
| workflow is not done until the e2e has actually passed against it. Either: | ||
|
|
||
| - run `.claude/run-e2e-tests.sh` locally, or | ||
| - if you pushed, the `Tests` CI workflow (`.github/workflows/tests.yml`) runs the | ||
| same `tests/test_e2e.sh` on the PR. In that case set a watcher and confirm it | ||
| succeeds before reporting the change as validated: | ||
|
|
||
| ```bash | ||
| gh run watch "$(gh run list --branch <branch> --workflow Tests --limit 1 --json databaseId --jq '.[0].databaseId')" --exit-status | ||
| ``` | ||
|
|
||
| Don't run a local e2e *and* let CI run the identical pushed commit — that spends | ||
| two throwaway repos for one check. Pick one. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.