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

Updates tools/test README #2481

Merged
merged 3 commits into from
Sep 17, 2024
Merged

Updates tools/test README #2481

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce99304
Update README.md
TheSonOfThomp Sep 16, 2024
597952d
Update README.md
TheSonOfThomp Sep 16, 2024
d0ccdc5
Merge branch 'main' into adam/r17-test-readme
TheSonOfThomp Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions tools/test/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,19 @@ You can also pass a `--config` option to the test command:
```bash
> lg test --config ./path/to/config
```

### Testing in React 17

In CI we test our components using React 17.

To do this manually, first run the [init script](./scripts/install-react17.ts) in order to install the specific testing dependencies needed for React 17. (`yarn init17` from the repo root)

```bash
> yarn init17
Copy link
Collaborator

Choose a reason for hiding this comment

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

to exit react17 mode, would we run yarn?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think you need to clean first, but yeah. I'll add that

```

Next, run your tests with the `--react17` flag. This ensures that the tests are run with specific Jest config for React 17.

```bash
> yarn test --react17
```
Loading