Skip to content

Commit

Permalink
Deprecate customBuildName and project options.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sreyanth committed May 11, 2020
1 parent b9794a7 commit 234a45c
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
"npm-package-you-need-to-run-tests-2@1.0.0"
Expand Down Expand Up @@ -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",
"npm-package-you-need-to-run-tests-2@1.0.0"
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 234a45c

Please sign in to comment.