Skip to content

Commit 5ced6ab

Browse files
jennifer-shehaneBarthélémy Ledoux
and
Barthélémy Ledoux
authoredJul 14, 2021
docs: Add README for some newly added packages (#17283)
Co-authored-by: Barthélémy Ledoux <[email protected]>
1 parent 0fc3944 commit 5ced6ab

File tree

5 files changed

+73
-3
lines changed

5 files changed

+73
-3
lines changed
 

‎.github/CODEOWNERS

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Each line is a file pattern followed by one or more owners.
22

3-
# Test Runner team are owners of code within root packages and cli
3+
# Test Runner team are owners of code within root packages concerning e2e, cli, and other utils
4+
/.github/ @cypress-io/test-runner
45
/browser-versions.json @cypress-io/test-runner
56
/cli/ @cypress-io/test-runner
67
/packages/coffee/ @cypress-io/test-runner
@@ -19,9 +20,11 @@
1920
/packages/rewriter/ @cypress-io/test-runner
2021
/packages/root/ @cypress-io/test-runner
2122
/packages/runner/ @cypress-io/test-runner
23+
/packages/runner-shared/ @cypress-io/test-runner
2224
/packages/server/ @cypress-io/test-runner
2325
/packages/socket/ @cypress-io/test-runner
2426
/packages/static/ @cypress-io/test-runner
2527
/packages/ts/ @cypress-io/test-runner
2628
/packages/ui-components/ @cypress-io/test-runner
2729
/packages/web-config/ @cypress-io/test-runner
30+
/scripts/ @cypress-io/test-runner

‎CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -282,11 +282,13 @@ Here is a list of the core packages in this repository with a short description,
282282
| [reporter](./packages/reporter) | `@packages/reporter` | The reporter shows the running results of the tests (The Command Log UI). |
283283
| [root](./packages/root) | `@packages/root` | Dummy package pointing at the root of the repository. |
284284
| [runner](./packages/runner) | `@packages/runner` | The runner is the minimal "chrome" around the user's application under test. |
285+
| [runner-ct](./packages/runner-ct) | `@packages/runner-ct` | The runner for component testing |
286+
| [runner-shared](./packages/runner-shared) | `@packages/runner-shared` | The shared components between the `runner` and the `runner-ct` packages |
285287
| [server](./packages/server) | `@packages/server` | The <3 of Cypress. This orchestrates everything. The backend node process. |
286288
| [socket](./packages/socket) | `@packages/socket` | A wrapper around socket.io to provide common libraries. |
287289
| [static](./packages/static) | `@packages/static` | Serves static assets used in the Cypress GUI. |
288290
| [ts](./packages/ts) | `@packages/ts` | A centralized version of typescript. |
289-
291+
290292
Public packages live within the [`npm`](./npm) folder and are standalone modules that get independently published to npm under the `@cypress/` namespace. These packages generally contain extensions, plugins, or other packages that are complementary to, yet independent of, the main Cypress app.
291293

292294
Here is a list of the npm packages in this repository:

‎packages/runner-ct/README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Runner CT
2+
3+
The runner-ct is where the code for the component testing's runner lives and has the following responsibilities:
4+
5+
- Displaying the component specs list and all states around that in the runner
6+
7+
## Developing
8+
9+
### Watching
10+
11+
This watches and compiles all changes as you make them.
12+
13+
```bash
14+
yarn workspace @packages/runner-ct watch
15+
```
16+
17+
## Building
18+
19+
### For development
20+
21+
```bash
22+
yarn workspace @packages/runner-ct build
23+
```
24+
25+
### For production
26+
27+
```bash
28+
yarn workspace @packages/runner-ct build-prod
29+
```
30+
31+
## Testing
32+
33+
### Cypress Tests
34+
35+
You can run Cypress tests found in [`cypress/component`](./cypress/component):
36+
37+
```bash
38+
yarn workspace @packages/runner-ct cypress:open
39+
```
40+
41+
To watch and reload changes to the runner while testing you'll want to run:
42+
43+
```bash
44+
yarn workspace @packages/runner-ct watch
45+
```

‎packages/runner-shared/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Runner Shared
2+
3+
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:
4+
5+
- Shared empty states
6+
- Shared error states
7+
- Containers, headers and iframe components
8+
- Selector playground and Cypress Studio
9+
10+
## Developing
11+
12+
The components are imported to the [`runner`](../runner/README.md#Developing) and `runner-ct` packages respectively. Please see their instructions for develoment.
13+
14+
## Testing
15+
16+
### Unit Tests
17+
18+
```bash
19+
yarn workspace @packages/runner-shared test
20+
```

‎packages/runner/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Runner](https://cloud.githubusercontent.com/assets/1157043/17947042/e9352ae2-6a18-11e6-85af-3670c7cfba03.png)
44

5-
The runner is the minimal "chrome" around the user's app and has the following responsibilities:
5+
The runner is the minimal "chrome" around the user's app for end-to-end testing and has the following responsibilities:
66

77
- Managing communication between the driver, the reporter, the extension, and the server
88
- Managing the viewport size and scale

4 commit comments

Comments
 (4)

cypress-bot[bot] commented on Jul 14, 2021

@cypress-bot[bot]
Contributor

Circle has built the linux x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/7.8.0/circle-develop-5ced6abb2d8919d31d44f54df3c3423ac26fec69/cypress.tgz

cypress-bot[bot] commented on Jul 14, 2021

@cypress-bot[bot]
Contributor

AppVeyor has built the win32 ia32 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/7.8.0/appveyor-develop-5ced6abb2d8919d31d44f54df3c3423ac26fec69/cypress.tgz

cypress-bot[bot] commented on Jul 14, 2021

@cypress-bot[bot]
Contributor

AppVeyor has built the win32 x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/7.8.0/appveyor-develop-5ced6abb2d8919d31d44f54df3c3423ac26fec69/cypress.tgz

cypress-bot[bot] commented on Jul 14, 2021

@cypress-bot[bot]
Contributor

Circle has built the darwin x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/7.8.0/circle-develop-5ced6abb2d8919d31d44f54df3c3423ac26fec69/cypress.tgz
Please sign in to comment.