diff --git a/.github/workflows/setup-env.yml b/.github/workflows/setup-env.yml index ea6cb981..f5bd9d71 100644 --- a/.github/workflows/setup-env.yml +++ b/.github/workflows/setup-env.yml @@ -1,4 +1,4 @@ -name: 'unit tests: setting test env for BrowserStack' +name: 'setup-env' on: pull_request: paths: diff --git a/.github/workflows/setup-local.yml b/.github/workflows/setup-local.yml index 08eb20ed..fce7179d 100644 --- a/.github/workflows/setup-local.yml +++ b/.github/workflows/setup-local.yml @@ -1,4 +1,4 @@ -name: 'unit tests: setting local binary for BrowserStack' +name: 'setup-local' on: pull_request: paths: diff --git a/README.md b/README.md index 8878773b..15a79224 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # BrowserStack GitHub Actions +

+ BrowserStack Logo +

+ +

+ setup-env build status + setup-local build status +

+ This respository contains a library of GitHub Actions to help you integrate your test suite with the [BrowserStack](https://browserstack.com) device cloud. You need a BrowserStack username and access-key to run your tests on the BrowserStack device cloud. You can [sign-up for free trial](https://www.browserstack.com/users/sign_up) if you do not have an existing account. @@ -11,7 +20,7 @@ If you want to test your open source project on BrowserStack, then [sign-up here * [setup-local](./setup-local): This Action downloads and starts the appropriate BrowserStackLocal binary, thereby creating a secure tunnel connection from the GitHub Actions runner environment to the BrowserStack device cloud. This secure tunnel will be used by the remote browsers in BrowserStack to access your web application hosted in the GitHub Actions runner environment. **You do not need this Action if the application to be tested is accessible over the public internet.** -## Pre-requisites +## Prerequisites * You should set your BrowserStack Username and Access Key as GitHub Secrets, i.e. `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` respectively. ## Usage