From 37ba34cf94c7f4ad7d0d0a6d580d0d66e3137e52 Mon Sep 17 00:00:00 2001
From: Pedro Silva <pedro@budibase.com>
Date: Sun, 26 Mar 2023 18:12:26 +0100
Subject: [PATCH] Update readme

---
 qa-core/README.md    | 20 ++++++++++++++++----
 qa-core/package.json |  2 +-
 2 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/qa-core/README.md b/qa-core/README.md
index b812742ab3..c9d0727878 100644
--- a/qa-core/README.md
+++ b/qa-core/README.md
@@ -3,20 +3,32 @@
 The QA Core API tests are a jest suite that run directly against the budibase backend APIs.
 
 ## Auto Setup
+
 You can run the whole test suite with one command, that spins up the budibase server and runs the jest tests:
 
-`yarn api:test` 
+`yarn api:test`
 
 ## Setup Server Only
+
 You can also just stand up the budibase server alone.
 
-`yarn api:server:setup` 
+`yarn api:server:setup`
 
 ## Run Tests
+
 If you configured the server using the previous command, you can run the whole test suite by using:
 
-`yarn test` 
+`yarn test`
 
 for watch mode, where the tests will run on every change:
 
-`yarn test:watch` 
\ No newline at end of file
+`yarn test:watch`
+
+To run tests locally against a cloud service you can use the command:
+`yarn run api:test:local`
+
+To run the tests in CI, it assumes the correct environment variables are set, and the server is already running. Use the command:
+`yarn run api:test:ci`
+
+To run the nightly tests against the QA environment, use the command:
+`yarn run api:test:nightly`
diff --git a/qa-core/package.json b/qa-core/package.json
index 59c028f9f9..9a5cc8dc32 100644
--- a/qa-core/package.json
+++ b/qa-core/package.json
@@ -21,7 +21,7 @@
     "api:test:ci": "start-server-and-test api:server:setup:ci http://localhost:4100/builder test",
     "api:test": "start-server-and-test api:server:setup http://localhost:4100/builder test",
     "api:test:local": "env-cmd jest --runInBand --testPathIgnorePatterns=\\\"\\/dataSources\\/\\\"",
-    "api:test:withDataSources": "env-cmd jest --runInBand --outputFile=testResults.json"
+    "api:test:nightly": "env-cmd jest --runInBand --outputFile=testResults.json"
   },
   "jest": {
     "preset": "ts-jest",