From 26bf40b1e7dce556332cb5e3a9eb7ff090d1f107 Mon Sep 17 00:00:00 2001 From: Alex Cottner Date: Tue, 21 May 2024 14:08:14 -0600 Subject: [PATCH] updating readme with testing locally section --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b68af40..100a43a 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,12 @@ npx run start:linux -- --firefox-profile rs-devtools --profile-create-if-missing More information about the temporary loaded addon can be found in `about:debugging#/runtime/this-firefox` +## Running tests locally +Automated tests can be run locally or in docker to verify changes. + - `npm run tcs:docker` - will build and run the automated tests within a container using the latest firefox nightly package. + - `npm run tcs:test` to run automated tests locally using your firefox nightly package. + - Setting the `NIGHTLY_PATH` environment parameter will allow you to run tests against an arbitrary firefox nightly binary. Ex: `NIGHTLY_PATH=/opt/custom/nightly npm run tcs:test` + # Release ### Prerequisites (get access to Ship-It)