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

Add more readme for integration tests #4515

Merged
merged 2 commits into from Apr 11, 2023
Merged

Add more readme for integration tests #4515

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
945e5f4
Add more readme for integration tests
mehulkar Apr 10, 2023
082e66a
tiniest nit
mehulkar Apr 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 17 additions & 1 deletion cli/integration_tests/README.md
View file
Open in desktop
Expand Up @@ -16,13 +16,29 @@ Setup
$ . ${TESTDIR}/setup_monorepo.sh $(pwd)
```

- `setup.sh` sets a `TURBO` environment variable that points to the locally built binary
- `setup.sh` sets a `TURBO` environment variable that points to the locally built binary.
- `setup_monorepo.sh` uses one of the test repos in the `_fixtures` directory to exercise
the `TURBO` binary against.

### Fixtures

For the most part, use the `basic_monorepo`, or `single_package` fixtures to test against.
By default the script will use `basic_monorepo`, but you can specify the fixture with a second
argument:

```bash
$ . ${TESTDIR}/setup_monorepo.sh $(pwd) single_package
```

You can also pass a second argument to change the packageManager of a fixture:

```bash
$ . ${TESTDIR}/setup_monorepo.sh $(pwd) basic_monorepo "yarn@1.22.17"
```

Note that if you want to customize the package mangaer, you'll have to specify the fixture name
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note that if you want to customize the package mangaer, you'll have to specify the fixture name
Note that if you want to customize the package manager, you'll have to specify the fixture name

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

automerge doesn't respect suggestions I guess

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed here: df0a60e

also since the script just uses positional arguments.

You can add custom fixture monorepos as an escape hatch or if you truly need a custom monorepo.

#### Custom turbo.json
Expand Down