Skip to content

Commit 41ab585

Browse files
committedAug 20, 2020
add: parent action readme. Fix: yaml snippet prettier in readme.
1 parent 718ea73 commit 41ab585

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed
 

‎README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
This respository contains a library of GitHub Actions to help you integrate your test suite with the [BrowserStack](https://browserstack.com) device cloud.
44

5-
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.
5+
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.
6+
67
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.
78

89
## Available Actions
@@ -25,7 +26,7 @@ As this is a library of Actions, invoking this Action will trigger the `setup-en
2526
build-name: BUILD_INFO
2627
project-name: REPO_NAME
2728
```
28-
We recommend you to invoke individual Actions from this library separately. A sample of two Actions being invoked back to back 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.
29+
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.
2930

3031
## Sample Workflow with usage of both Actions
3132
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.
@@ -52,9 +53,12 @@ jobs:
5253
local-testing: start
5354
local-identifier: random
5455
```
55-
Post these setup steps where both the Actions have been used, you have to build and run your application web server on the same machine, in daemon mode and thereafter invoke your test scripts. Your test scripts should use the environment variables that have been set by [`setup-env` Action](./setup-env). 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.
5656

57-
After you are done running your tests, invoke the `setup-local` Action again with `local-testing: stop` as an input:
57+
### Note
58+
---
59+
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.
60+
61+
After you are done running your tests, invoke the `setup-local` Action again with `local-testing: stop` as the input:
5862
```yaml
5963
- name: 'BrowserStackLocal Stop'
6064
uses: 'browserstack/github-actions/setup-local@master'

‎setup-env/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This action sets up the following environment variables in the runner environmen
1616
* This action does not have any prerequisites.
1717

1818
## Usage
19-
```
19+
```yaml
2020
- name: 'BrowserStack Env Setup'
2121
uses: 'browserstack/github-actions/setup-env@master'
2222
with:
@@ -28,7 +28,7 @@ This action sets up the following environment variables in the runner environmen
2828
2929
or
3030
31-
```
31+
```yaml
3232
- name: 'BrowserStack Env Setup'
3333
uses: 'browserstack/github-actions/setup-env@master'
3434
with:

‎setup-local/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The **browserstack/github-actions/setup-env@master** action should have been inv
3939

4040
## Usage
4141
Use the code snippet below in your workflow to start the BrowserStackLocal binary and establish the tunnel connection:
42-
```
42+
```yaml
4343
- name: 'Start BrowserStackLocal Tunnel'
4444
uses: 'browserstack/github-actions/setup-local@master'
4545
with:
@@ -49,7 +49,7 @@ Use the code snippet below in your workflow to start the BrowserStackLocal binar
4949
```
5050
5151
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):
52-
```
52+
```yaml
5353
- name: 'Stop BrowserStackLocal'
5454
uses: 'browserstack/github-actions/setup-local@master'
5555
with:

0 commit comments

Comments
 (0)
Please sign in to comment.