README for each action

README.md

@@ -1,4 +1,69 @@
-BrowserStack Actions
+# BrowserStack GitHub Actions
 
-1. Setup Test Environment: [Readme](./setup-env/README.md)
-2. Local Binary Setup: [Readme](./setup-local/README.md)
+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.
+
+If you want to test your open source project on BrowserStack, then [sign-up here](https://www.browserstack.com/open-source) for lifetime free access to all our products.
+
+## Available Actions
+* [setup-env](./setup-env): This Action helps in setting up the required environment variables that are to be used in your test scripts. The environment variables set up here shall be used by other BrowserStack actions as well for their functioning.
+
+* [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
+* You should set your BrowserStack Username and Access Key as GitHub Secrets, i.e. `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` respectively.
+
+## Usage
+As this is a library of Actions, invoking this Action will trigger the `setup-env` Action internally. The following usage example will **only** set up the required environment variables:
+
+```yaml
+- name: BrowserStack Action
+  uses: 'browserstack/github-actions@master'
+  with:
+    username:  ${{ secrets.BROWSERSTACK_USERNAME }}
+    access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+    build-name: BUILD_INFO
+    project-name: REPO_NAME
+```
+We recommend you to invoke the Actions individually depending on the use case. A sample workflow for the same is shown below. You can additionally refer to the individual `README` ([setup-env](./setup-env), [setup-local](./setup-local)) of the Actions to know more about how they work, the inputs they support and their usage examples.
+
+## Sample Workflow with usage of both Actions
+The workflow example below would be useful when the web application to be tested is hosted on the GitHub Actions runner environment, i.e. not accessible from the public Internet.
+
+```yaml
+name: 'BrowserStack Test'
+on: [push, pull_request]
+
+jobs:
+  ubuntu-job:
+    name: 'BrowserStack Test on Ubuntu'
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'BrowserStack Env Setup'
+        uses: 'browserstack/github-actions/setup-env@master'
+        with:
+          username:  ${{ secrets.BROWSERSTACK_USERNAME }}
+          access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+          build-name: BUILD_INFO
+          project-name: REPO_NAME
+      - name: 'BrowserStackLocal Setup'
+        uses: 'browserstack/github-actions/setup-local@master'
+        with:
+          local-testing: start
+          local-identifier: random
+```
+
+### Note
+---
+Post these steps, you will have to build and run your application web server on the same runner environment. Further, invoke your test scripts by utilizing the environment variables that have been set by actions. For more detailed steps on how to integrate your test suite with BrowserStack on GitHub Actions, visit [BrowserStack Documentation](http://browserstack.com/docs/automate/selenium/github-actions) for the same.
+
+After you are done running your tests, invoke the `setup-local` Action again with `local-testing: stop` as the input:
+```yaml
+      - name: 'BrowserStackLocal Stop'
+        uses: 'browserstack/github-actions/setup-local@master'
+        with:
+          local-testing: stop
+```
+## Feature requests and bug reports
+Please file feature requests and bug reports as [github issues](https://github.com/browserstack/github-actions/issues).

setup-env/README.md

@@ -1 +1,59 @@
-README for Setup BrowserStack Test Environment
+# setup-env
+
+This action sets up the following environment variables in the runner environment. These environment variables shall be used in the tests for BrowserStack:
+
+1. `BROWSERSTACK_BUILD_NAME`: This environment variable is set on the basis of the input to `build-name` field. By default, the value will be decided based on the event, i.e. push, pull_request etc for the workflow:
+   1. `push` event: `[<Branch-Name>] Commit <commit-sha>: <commit-message> [Workflow: <Workflow-number>]`
+   2. `pull_request` event: `[<Branch-Name>] PR <PR-number>: <PR-title> [Workflow: <Workflow-number>]`
+   3. `release` event: `[<Branch-Name>] Release <Release-tag>: <Release-name> [Workflow: <Workflow-number>]`
+   4. Other events: `<Event-Name> [Workflow: <Workflow-number>]`
+
+2. `BROWSERSTACK_PROJECT_NAME`: This environment variable is set on the basis of the input to `project-name` field. By default, i.e. if any input is not provided, the value will be set as the Repository Name.
+3. `BROWSERSTACK_USERNAME`: This environment variable's value is taken from the input to `username` field. Ideal way would be to pass the GitHub Secret as the input, i.e. `username: ${{ secrets.BROWSERSTACK_USERNAME }}`.
+4. `BROWSERSTACK_ACCESS_KEY`: This environment variable's value is taken from the input to `access-key` field. Ideal way would be to pass the GitHub Secret as the input, i.e. `access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}`.
+
+## Prerequisites
+* This action does not have any prerequisites.
+
+## Usage
+```yaml
+- name: 'BrowserStack Env Setup'
+  uses: 'browserstack/github-actions/setup-env@master'
+  with:
+    username:  ${{ secrets.BROWSERSTACK_USERNAME }}
+    access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+    build-name: BUILD_INFO
+    project-name: REPO_NAME
+```
+
+or
+
+```yaml
+- name: 'BrowserStack Env Setup'
+  uses: 'browserstack/github-actions/setup-env@master'
+  with:
+    username:  ${{ secrets.BROWSERSTACK_USERNAME }}
+    access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+```
+
+## Inputs
+* `username`: (**Mandatory**) This is your BrowserStack Username. This should ideally be passed via a GitHub Secret as shown in the sample workflow above.
+* `access-key`: (**Mandatory**) This is your BrowserStack Access key that is required to access the BrowserStack device cloud. This should also ideally be passed via a GitHub Secret as shown in the sample workflow above.
+* `build-name`: (**Optional**)
+  * You can pass any string that you want to set as the `BROWSERSTACK_BUILD_NAME`. E.g. `build-name: My Build Name Goes Here`.
+  * You can also include your personalized string along with the keyword `BUILD_INFO` in the input:
+    * `build-name: My String Goes Here - BUILD_INFO`
+    * `build-name: BUILD_INFO - My String at the end`
+    * `build-name: String at the Beginning - BUILD_INFO - String at the end`
+  * The keyword `BUILD_INFO` will be replaced by the information based on the event of the workflow as described above for `BROWSERSTACK_BUILD_NAME` environment variable.
+* `project-name`: (**Optional**)
+  * You can pass any string that you want to set as the `BROWSERSTACK_PROJECT_NAME`. E.g. `project-name: My Project Name Goes Here`.
+  * You can also pass the keyword `REPO_NAME` as the input. This will set the Repository Name for the `BROWSERSTACK_PROJECT_NAME` environment variable.
+  * If no input is provided, `REPO_NAME` will be considered as the default input.
+
+---
+**NOTE**
+* This action is a prerequisite for any other BrowserStack related actions.
+* This action should be invoked prior to the execution of tests on BrowserStack to be able to utilise the environment variables in your tests.
+* You have to use the environment variables set by this action in your test script.
+---

setup-local/README.md

@@ -1 +1,57 @@
-README for Setup BrowserStack Local Binary
+# setup-local
+This action fulfils the following objectives in your runner environment:
+* It will download the appropriate type of BrowserStackLocal binary in your runner environment depending on the environment, i.e. Linux/Darwin/Win32.
+* It will start (or stop) the binary and establish (or end) the Local tunnel connection from the runner machine to the BrowserStack cloud as per the input for `local-testing` field.
+* The action provides the functionality to specify the logging level of the binary and then upload the logs as artifacts in GitHub workflow.
+* The action allows you to pass any combination of arguments for the invocation of the BrowserStackLocal binary as given [here](https://www.browserstack.com/local-testing/binary-params).
+
+## Prerequisites
+The **browserstack/github-actions/setup-env@master** action should have been invoked prior to invoking this action as a part of the same job.
+
+## Inputs
+* `local-testing`: (**Mandatory**)
+  * Valid inputs:
+    * `start`: This will download the BrowserStackLocal binary (if it wasn't downloaded earlier by this action in the same runner environment) and start the binary with additional inputs that you might provide. The `local-identifier` that is used to start the binary will be set in the environment variable `BROWSERSTACK_LOCAL_IDENTIFIER`. The same will be used for stopping the binary when using the `stop` input.
+    * `stop`: This will ensure that a previously running binary will be stopped and if any log-level was set by `local-logging-level`, then the logs will be uploaded as artifacts. **If you do not stop the binary after the completion of your tests, the logs will not be uploaded as artifacts.**
+* `local-logging-level`: (**Optional**)
+  * Valid inputs:
+    * `false`: No local binary logs will be captured.
+    * `setup-logs`: Local logs to debug issues related to setting up of connections will be saved. They will be uploaded as artifacts only if the action is again invoked with `local-testing: stop`.
+    * `network-logs`: Local logs related to network information will be saved. They will be uploaded as artifacts only if the action is again invoked with `local-testing: stop`.
+    * `all-logs`: Local logs related to all communication to local servers for each request and response will be saved. They will be uploaded as artifacts only if the action is again invoked with `local-testing: stop`.
+  * Default: `false`.
+* `local-identifier`: (**Optional**)
+  * Valid inputs:
+    * `random`: This is the recommended value for this input. A randomly generated string will be used to start the local tunnel connection and the string will be saved in the environment variable `BROWSERSTACK_LOCAL_IDENTIFIER`. You must use the same environment variable in your test script to specify the tunnel identifier in capabilities.
+    * `<string>`: You can choose any value for the `string`. The same will be saved in the environment variable `BROWSERSTACK_LOCAL_IDENTIFIER` which you must use in your test script to specify the tunnel identifier in capabilities.
+  * Default: If you do not provide any input, then no tunnel identifier will be used. This option is not recommended because if multiple tunnels are created without any identifier (or with same identifier) for the same access-key, then tests might behave abnormally. It is strongly advised not to choose this option.
+* `local-args`: (**Optional**)
+  * Valid input: You can choose to pass any additional arguments to start the local binary through this option. All your arguments must be a part of this single string. You can find the complete list of supported local-binary arguments [here](https://www.browserstack.com/local-testing/binary-params).
+  * E.g. `local-args: --force-local --proxy-host <HOST> --proxy-port <PORT> --proxy-user <USER> --proxy-pass <PASSWORD>`
+  * **NOTE**: Do not include the following arguments as a part of this input string (they will be ignored if passed):
+    * `--key` or `-k`
+    * `--local-identifier`
+    * `--daemon`
+    * `--only-automate`
+    * `--verbose`
+    * `--log-file`
+    * The above arguments are already being included in the invocation of the local binary and hence, if you include any of the above again in the `local-args` string, they will be ignored. `local-args` is an optional argument and under normal circumstances, if the application is not hosted behind any proxy, this input would not be required. Visit [this page](https://www.browserstack.com/local-testing/binary-params) to see if any additional argument is applicable to your test scenario.
+
+## Usage
+Use the code snippet below in your workflow to start the BrowserStackLocal binary and establish the tunnel connection:
+```yaml
+- name: 'Start BrowserStackLocal Tunnel'
+  uses: 'browserstack/github-actions/setup-local@master'
+  with:
+    local-testing: start
+    local-logging-level: all-logs
+    local-identifier: random
+```
+
+Use the code snippet below at the end of your workflow after the tests have completed. This will stop the BrowserStackLocal binary and upload the local binary logs (if any):
+```yaml
+- name: 'Stop BrowserStackLocal'
+  uses: 'browserstack/github-actions/setup-local@master'
+  with:
+    local-testing: stop
+```