-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deprecate customBuildName and project options.
- Loading branch information
Showing
1 changed file
with
12 additions
and
11 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -81,8 +81,8 @@ specified folder. | |
], | ||
"run_settings": { | ||
"cypress_proj_dir": "/path/to/directory-that-contains-<cypress.json>-file", | ||
"project": "my first project", | ||
"custom_build_name": "build 1", | ||
"project_name": "my first project", | ||
"build_name": "build 1", | ||
"npm_dependencies": [ | ||
"npm-package-you-need-to-run-tests-1", | ||
"[email protected]" | ||
|
@@ -153,21 +153,21 @@ Example: | |
You can use `run_settings` option to specify the settings to run your tests on | ||
BrowserStack. | ||
|
||
| Option | Description | Possible values | | ||
| ------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------- | | ||
| `cypress_proj_dir` | Path to the folder which contains `cypress.json` file. | - | | ||
| `project` | Name of your project. You'll be able to search & filter your tests on the dashboard using this. | - | | ||
| `custom_build_name` | Name of your build / CI run. You'll be able to search & filter your tests on the dashboard using this. username. | - | | ||
| `npm_dependencies` | A list of NPM packages to be able to run your Cypress tests. | - | | ||
| Option | Description | Possible values | | ||
| ------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------- | | ||
| `cypress_proj_dir` | Path to the folder which contains `cypress.json` file. | - | | ||
| `project_name` | Name of your project. You'll be able to search & filter your tests on the dashboard using this. | - | | ||
| `build_name` | Name of your build / CI run. You'll be able to search & filter your tests on the dashboard using this. username. | - | | ||
| `npm_dependencies` | A list of NPM packages to be able to run your Cypress tests. | - | | ||
|
||
Example: | ||
|
||
```json | ||
{ | ||
"run_settings": { | ||
"cypress_proj_dir": "/path/to/directory-that-contains-<cypress.json>-file", | ||
"project": "my first project", | ||
"custom_build_name": "build 1", | ||
"project_name": "my first project", | ||
"build_name": "build 1", | ||
"npm_dependencies": [ | ||
"npm-package-you-need-to-run-tests-1", | ||
"[email protected]" | ||
|
@@ -230,7 +230,8 @@ options. | |
| Deprecated option | New favoured option | Remarks | | ||
| ----------------- | ------------------- | ----------------------------- | | ||
| `specs` | `cypress_proj_dir` | Used in `run_settings` | | ||
| `customBuildName` | `custom_build_name` | Used in `run_settings` | | ||
| `project` | `project_name` | Used in `run_settings` | | ||
| `customBuildName` | `build_name` | Used in `run_settings` | | ||
| `localIdentifier` | `local_identifier` | Used in `connection_settings` | | ||
|
||
## CLI Arguments & Flags | ||
|