Skip to content

Commit cd8f256

Browse files
authored
Update SmartUI GitHub READ.ME
1 parent 6022813 commit cd8f256

File tree

1 file changed

+109
-21
lines changed

1 file changed

+109
-21
lines changed

README.md

Lines changed: 109 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,81 @@
1-
# smartui-github-testing
1+
Smart UI Testing With GitHub ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)
22

3-
For Testing Github App Integration with SmartUI
3+
<img height="400" src="https://user-images.githubusercontent.com/70570645/171361733-065df506-c302-452d-8bc7-e63047377f8e.png">
44

5+
<p align="center">
6+
<a href="https://www.lambdatest.com/blog/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Blog</a>
7+
&nbsp; &#8901; &nbsp;
8+
<a href="https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Docs</a>
9+
&nbsp; &#8901; &nbsp;
10+
<a href="https://www.lambdatest.com/learning-hub/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Learning Hub</a>
11+
&nbsp; &#8901; &nbsp;
12+
<a href="https://www.lambdatest.com/newsletter/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Newsletter</a>
13+
&nbsp; &#8901; &nbsp;
14+
<a href="https://www.lambdatest.com/certifications/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Certifications</a>
15+
&nbsp; &#8901; &nbsp;
16+
<a href="https://www.youtube.com/c/LambdaTest" target="_bank">YouTube</a>
17+
</p>
18+
&emsp;
19+
&emsp;
20+
&emsp;
521

22+
*Learn the how to get started with testing GitHub app integration with SmartUI on the LambdaTest platform.*
623

7-
### Getting Started Github App Integration with SmartUI Product - Selenium Automation
24+
[<img height="58" width="200" src="https://user-images.githubusercontent.com/70570645/171866795-52c11b49-0728-4229-b073-4b704209ddde.png">](https://accounts.lambdatest.com/register?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample)
825

9-
Steps 1: Setup Github App with lambdatest from link github setup
1026

11-
- Using OAuth
27+
## Table of Contents:
1228

13-
- Cloud, or
29+
* [Pre-requisites](#pre-requisites)
30+
* [Getting Started With Github App Integration with SmartUI](#getting-started-with-github-app-integration-with-smartui)
31+
32+
33+
## Pre-requisites
34+
35+
* An account with Github with valid permission to install new applications to your repositories.
36+
* Basic understanding of Continuos Integration tools (CI) is required.
37+
* Should have setup the SmartUI suite, else please read [this](https://www.lambdatest.com/support/docs/selenium-visual-regression/).
38+
39+
## Getting Started With Github App Integration with SmartUI
40+
41+
### Steps 1: Integrate the your Lambdatest Account with GitHub App.
1442

43+
You can integrate your LambdaTest account with the GiHub application in the following ways:
44+
45+
- Using OAuth
46+
- Cloud, or
1547
- Self Hosted
1648

17-
Step 2: Once setup is done, you will see like
49+
### Step 2: Select your GitHub repository
1850

19-
Step 3: Now you need to setup a sample repository where your test case are mentioned, [smartui-github-testing](https://github.com/LambdaTest/smartui-github-testing)
51+
Go to your GitHub repository where you want to configure your SmartUI project. Check out our GitHub sample [here](https://github.com/LambdaTest/smartui-node-sample).
2052

21-
Step 4: For Github Status updates on PR/ commit need to add capabilities in test suite,
53+
### Step 3: Configure your test suite
2254

23-
```
24-
github: {
25-
"url": "https://api.github.com/repos/OWNER/REPO/statuses/commitId",
26-
"owner": "{OWNER}", //Optional
27-
"repo": "{REPO}", //Optional
28-
"commit": "{commitId}" //Optional
29-
},
55+
Add the `Github` capability to your current test configuration:
56+
57+
```bash
58+
const capabilities: {
59+
platform: "Windows 10",
60+
browserName: "chrome",
61+
version: "latest",
62+
"smartUI.project": "Smart UI sample test",
63+
github: {
64+
"url": "https://api.github.com/repos/OWNER/REPO/statuses/commitId", // Mandatory
65+
"owner": "{OWNER}", //Optional
66+
"repo": "{REPO}", //Optional
67+
"commit": "{commitId}" //Optional
68+
}
69+
}
3070
```
3171

32-
Step5: How to get the `github.url` value in test suite
72+
### Step 4: Setting up your CI configuration
3373

34-
Here we have taken an example of github action, Add below steps in your github action file [.github/workflows/ci.yml](https://github.com/LambdaTest/smartui-github-testing/blob/main/.github/workflows/ci.yml)
74+
Setting up your CI workflow to execute on GitHub. Here is an example setup with `GitHub Actions`:
3575

36-
```
76+
Go to `.github/workflows/<your_ci_file>.yml`.
77+
78+
```bash
3779
name: Execute SmartUI Test with Github App Integration
3880
runs-on: ubuntu-latest
3981
steps:
@@ -52,7 +94,53 @@ Here we have taken an example of github action, Add below steps in your github a
5294
echo "GITHUB_URL=$GITHUB_URL" >> $GITHUB_ENV
5395
```
5496

97+
### Step5: Execute your test suite with CI
98+
99+
After the setup is completed, you can now execute your test suite with the Continuos Integration (CI) pipeline with any tool of your choice.
100+
101+
### Step 6: Commit you changes over git on a branch and raise the PR to main branch.
102+
103+
### Step 7: Now you will see the `lambdatest-smartui-app` in the PR.
104+
105+
## Documentation & Resources :books:
106+
107+
Visit the following links to learn more about LambdaTest's features, setup and tutorials around test automation, mobile app testing, responsive testing, and manual testing.
108+
109+
* [LambdaTest Documentation](https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample)
110+
* [LambdaTest Blog](https://www.lambdatest.com/blog/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample)
111+
* [LambdaTest Learning Hub](https://www.lambdatest.com/learning-hub/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample)
112+
113+
## LambdaTest Community :busts_in_silhouette:
114+
115+
The [LambdaTest Community](https://community.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample) allows people to interact with tech enthusiasts. Connect, ask questions, and learn from tech-savvy people. Discuss best practises in web development, testing, and DevOps with professionals from across the globe 🌎
116+
117+
## What's New At LambdaTest ❓
118+
119+
To stay updated with the latest features and product add-ons, visit [Changelog](https://changelog.lambdatest.com/)
120+
121+
## About LambdaTest
122+
123+
[LambdaTest](https://www.lambdatest.com?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample) is an intelligent unified digital experience testing cloud that helps businesses drastically reduce time to market through faster test execution, ensuring quality releases and accelerated digital transformation. The platforms allows you to perform both real time and automation testing across 3000+ environments and real mobile devices, making it a top choice among other cloud testing platforms. Over 10,000+ enterprise customers and 2+ million users across 130+ countries rely on LambdaTest for their testing needs.
124+
125+
### Features
126+
127+
* Run Selenium, Cypress, Puppeteer, Playwright, and Appium automation tests across 3000+ real desktop and mobile environments.
128+
* Real-time cross browser testing on 3000+ environments.
129+
* Test on Real device cloud
130+
* Blazing fast test automation with HyperExecute
131+
* Accelerate testing, shorten job times and get faster feedback on code changes with Test At Scale.
132+
* Smart Visual Regression Testing on cloud
133+
* 120+ third-party integrations with your favorite tool for CI/CD, Project Management, Codeless Automation, and more.
134+
* Automated Screenshot testing across multiple browsers in a single click.
135+
* Local testing of web and mobile apps.
136+
* Online Accessibility Testing across 3000+ desktop and mobile browsers, browser versions, and operating systems.
137+
* Geolocation testing of web and mobile apps across 53+ countries.
138+
* LT Browser - for responsive testing across 50+ pre-installed mobile, tablets, desktop, and laptop viewports
139+
140+
[<img height="58" width="200" src="https://user-images.githubusercontent.com/70570645/171866795-52c11b49-0728-4229-b073-4b704209ddde.png">](https://accounts.lambdatest.com/register?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample)
141+
142+
## We are here to help you :headphones:
55143

56-
Step 6: Commit you changes over git on a branch and raise the PR to main branch
144+
* Got a query? we are available 24x7 to help. [Contact Us](mailto:[email protected])
145+
* For more info, visit - [LambdaTest](https://www.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample)
57146

58-
Step 7: Now you will see the `lambdatest-smartui-app` check in the PR

0 commit comments

Comments
 (0)