-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
docs: Add README for some newly added packages #17283
Merged
+73
−3
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 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
This file contains 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
This file contains 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 |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Runner CT | ||
|
||
The runner-ct is where the code for the component testing's runner lives and has the following responsibilities: | ||
|
||
- Displaying the component specs list and all states around that in the runner | ||
|
||
## Developing | ||
|
||
### Watching | ||
|
||
This watches and compiles all changes as you make them. | ||
|
||
```bash | ||
yarn workspace @packages/runner-ct watch | ||
``` | ||
|
||
## Building | ||
|
||
### For development | ||
|
||
```bash | ||
yarn workspace @packages/runner-ct build | ||
``` | ||
|
||
### For production | ||
|
||
```bash | ||
yarn workspace @packages/runner-ct build-prod | ||
``` | ||
|
||
## Testing | ||
|
||
### Cypress Tests | ||
|
||
You can run Cypress tests found in [`cypress/component`](./cypress/component): | ||
|
||
```bash | ||
yarn workspace @packages/runner-ct cypress:open | ||
``` | ||
|
||
To watch and reload changes to the runner while testing you'll want to run: | ||
|
||
```bash | ||
yarn workspace @packages/runner-ct watch | ||
``` |
This file contains 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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Runner Shared | ||
|
||
The runner-shared contains the shared components between the `runner` (use for end-to-end testing) and the `runner-ct` (used for component testing) including: | ||
|
||
- Shared empty states | ||
- Shared error states | ||
- Containers, headers and iframe components | ||
- Selector playground and Cypress Studio | ||
|
||
## Developing | ||
|
||
The components are imported to the [`runner`](../runner/README.md#Developing) and `runner-ct` packages respectively. Please see their instructions for develoment. | ||
|
||
## Testing | ||
|
||
### Unit Tests | ||
|
||
```bash | ||
yarn workspace @packages/runner-shared test | ||
``` |
This file contains 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
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.
Should we also add a runner-ct code owner and respective GH team?
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.
@lmiller1990 Yah, was leaving that to the CT team to decide if you want to have your team pinged whenever the code is touched in the packages you 'own'. It's been working well for us because things opened by outside contributors or other teams is pretty obvious if it touches something we should look at without looking through all the files.