Skip to content

Commit 234a45c

Browse files
committed
Deprecate customBuildName and project options.
1 parent b9794a7 commit 234a45c

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ specified folder.
8181
],
8282
"run_settings": {
8383
"cypress_proj_dir": "/path/to/directory-that-contains-<cypress.json>-file",
84-
"project": "my first project",
85-
"custom_build_name": "build 1",
84+
"project_name": "my first project",
85+
"build_name": "build 1",
8686
"npm_dependencies": [
8787
"npm-package-you-need-to-run-tests-1",
8888
@@ -153,21 +153,21 @@ Example:
153153
You can use `run_settings` option to specify the settings to run your tests on
154154
BrowserStack.
155155

156-
| Option | Description | Possible values |
157-
| ------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------- |
158-
| `cypress_proj_dir` | Path to the folder which contains `cypress.json` file. | - |
159-
| `project` | Name of your project. You'll be able to search & filter your tests on the dashboard using this. | - |
160-
| `custom_build_name` | Name of your build / CI run. You'll be able to search & filter your tests on the dashboard using this. username. | - |
161-
| `npm_dependencies` | A list of NPM packages to be able to run your Cypress tests. | - |
156+
| Option | Description | Possible values |
157+
| ------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------- |
158+
| `cypress_proj_dir` | Path to the folder which contains `cypress.json` file. | - |
159+
| `project_name` | Name of your project. You'll be able to search & filter your tests on the dashboard using this. | - |
160+
| `build_name` | Name of your build / CI run. You'll be able to search & filter your tests on the dashboard using this. username. | - |
161+
| `npm_dependencies` | A list of NPM packages to be able to run your Cypress tests. | - |
162162

163163
Example:
164164

165165
```json
166166
{
167167
"run_settings": {
168168
"cypress_proj_dir": "/path/to/directory-that-contains-<cypress.json>-file",
169-
"project": "my first project",
170-
"custom_build_name": "build 1",
169+
"project_name": "my first project",
170+
"build_name": "build 1",
171171
"npm_dependencies": [
172172
"npm-package-you-need-to-run-tests-1",
173173
@@ -230,7 +230,8 @@ options.
230230
| Deprecated option | New favoured option | Remarks |
231231
| ----------------- | ------------------- | ----------------------------- |
232232
| `specs` | `cypress_proj_dir` | Used in `run_settings` |
233-
| `customBuildName` | `custom_build_name` | Used in `run_settings` |
233+
| `project` | `project_name` | Used in `run_settings` |
234+
| `customBuildName` | `build_name` | Used in `run_settings` |
234235
| `localIdentifier` | `local_identifier` | Used in `connection_settings` |
235236

236237
## CLI Arguments & Flags

0 commit comments

Comments
 (0)