You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+8-4
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@
2
2
3
3
This respository contains a library of GitHub Actions to help you integrate your test suite with the [BrowserStack](https://browserstack.com) device cloud.
4
4
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
+
6
7
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.
7
8
8
9
## Available Actions
@@ -25,7 +26,7 @@ As this is a library of Actions, invoking this Action will trigger the `setup-en
25
26
build-name: BUILD_INFO
26
27
project-name: REPO_NAME
27
28
```
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.
29
30
30
31
## Sample Workflow with usage of both Actions
31
32
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:
52
53
local-testing: start
53
54
local-identifier: random
54
55
```
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.
56
56
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:
@@ -49,7 +49,7 @@ Use the code snippet below in your workflow to start the BrowserStackLocal binar
49
49
```
50
50
51
51
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):
0 commit comments