Skip to content

Commit 66ccc25

Browse files
chore: readme expand
1 parent 6684347 commit 66ccc25

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,19 +140,23 @@ yarn update-snapshots
140140
If a new org is required for NUTs tests, these are the steps to create and configure one.
141141

142142
1. Create a new STM org in [Org Farm](https://orgfarm.salesforce.com/farms)
143-
2. [Create a Connected App](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_connected_app.htm)
144-
3. Enable JWT authentication and [test it](https://developer.salesforce.com/docs/atlas.en-us.260.0.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_jwt_unified)
145-
4. Use the credentials as values for the respective NUTS environment variables.
143+
2. [Enable DevHub for Scratch Org Creation](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_setup_enable_devhub.htm)
144+
3. Enable the following org perm: CreateConnectedApps
145+
4. Increase the following org limits to 99: ProvScratchActiveLimit, ProvScratchDailyLimit, ScratchRequestActiveCount, ScratchRequestActiveLimit, ScratchRequestDailyLimit
146+
5. [Create a Connected App](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_connected_app.htm)
147+
6. Enable JWT authentication and [test it](https://developer.salesforce.com/docs/atlas.en-us.260.0.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_jwt_unified)
148+
7. Use the credentials as values for the respective NUTS environment variables.
146149

147150
## Running NUTs (integration tests) locally
148151

149152
NUTs (integration tests) run the plugin against a real org and, for component-preview tests, a real browser (Playwright). To run them locally:
150153

151154
1. **Environment variables**
152155
Copy `.env.template` to `.env` and set the values for your Dev Hub org and test setup:
153-
- `TESTKIT_JWT_KEY`, `TESTKIT_JWT_CLIENT_ID` – JWT auth for the test org
154-
- `TESTKIT_HUB_USERNAME`, `TESTKIT_HUB_INSTANCE` – Dev Hub org
155-
- `TESTKIT_EXECUTABLE_PATH` – path to the `sf` CLI (default in template is `./node_modules/.bin/sf`)
156+
- `TESTKIT_JWT_KEY` - ./server.key from JWT configuration
157+
- `TESTKIT_JWT_CLIENT_ID` – Client id from JWT configuration
158+
- `TESTKIT_HUB_USERNAME` - Dev Hub username
159+
- `TESTKIT_HUB_INSTANCE` – Dev Hub login URL
156160

157161
2. **Run all NUTs** (loads variables from `.env` via `dotenv/config`):
158162

0 commit comments

Comments
 (0)