Skip to content

Commit 8f95a02

Browse files
authored
Merge pull request #2325 from RushilK7/stage
link fixes
2 parents 530ffc9 + 1d2b9d2 commit 8f95a02

File tree

3 files changed

+122
-163
lines changed

3 files changed

+122
-163
lines changed

docs/smartui-gitlab-pr-checks-exec.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ The SmartUI configuration file is used to specify project settings. You can also
100100

101101
## Step 3: Configure GitLab CI/CD Pipeline
102102

103-
Create or update your `.gitlab-ci.yml` file. The key difference with the Exec method is that you use `npx smartui exec --gitURL` to run your tests.
103+
Create or update your `.gitlab-ci.yml` file. The key difference with the Exec method is that you use `npx smartui exec --githubURL` to run your tests.
104104

105105
### Complete GitLab CI/CD Configuration
106106

@@ -144,9 +144,9 @@ visual_regression_tests:
144144
echo "GitLab Status URL: ${GIT_URL}"
145145
146146
# Run tests with SmartUI Exec and GitLab integration
147-
npx smartui exec --gitURL "${GIT_URL}" -- npm test
148-
# Or: npx smartui exec --gitURL "${GIT_URL}" -- npx wdio run wdio.conf.ts
149-
# Or: npx smartui exec --gitURL "${GIT_URL}" -- npm run test:mobile
147+
npx smartui exec --githubURL "${GIT_URL}" -- npm test
148+
# Or: npx smartui exec --githubURL "${GIT_URL}" -- npx wdio run wdio.conf.ts
149+
# Or: npx smartui exec --githubURL "${GIT_URL}" -- npm run test:mobile
150150
151151
only:
152152
- merge_requests
@@ -201,8 +201,8 @@ visual_regression_tests:
201201
echo "GitLab Status URL: ${GIT_URL}"
202202
203203
# Run tests with SmartUI Exec and GitLab integration
204-
npx smartui exec --gitURL "${GIT_URL}" -- mvn test
205-
# Or: npx smartui exec --gitURL "${GIT_URL}" -- ./gradlew test (for Gradle)
204+
npx smartui exec --githubURL "${GIT_URL}" -- mvn test
205+
# Or: npx smartui exec --githubURL "${GIT_URL}" -- ./gradlew test (for Gradle)
206206
207207
only:
208208
- merge_requests
@@ -253,9 +253,9 @@ visual_regression_tests:
253253
echo "GitLab Status URL: ${GIT_URL}"
254254
255255
# Run tests with SmartUI Exec and GitLab integration
256-
npx smartui exec --gitURL "${GIT_URL}" -- pytest
257-
# Or: npx smartui exec --gitURL "${GIT_URL}" -- python -m unittest discover
258-
# Or: npx smartui exec --gitURL "${GIT_URL}" -- behave
256+
npx smartui exec --githubURL "${GIT_URL}" -- pytest
257+
# Or: npx smartui exec --githubURL "${GIT_URL}" -- python -m unittest discover
258+
# Or: npx smartui exec --githubURL "${GIT_URL}" -- behave
259259
260260
only:
261261
- merge_requests
@@ -306,8 +306,8 @@ visual_regression_tests:
306306
echo "GitLab Status URL: ${GIT_URL}"
307307
308308
# Run tests with SmartUI Exec and GitLab integration
309-
npx smartui exec --gitURL "${GIT_URL}" -- bundle exec rspec
310-
# Or: npx smartui exec --gitURL "${GIT_URL}" -- bundle exec cucumber
309+
npx smartui exec --githubURL "${GIT_URL}" -- bundle exec rspec
310+
# Or: npx smartui exec --githubURL "${GIT_URL}" -- bundle exec cucumber
311311
312312
only:
313313
- merge_requests
@@ -327,17 +327,17 @@ visual_regression_tests:
327327
2. **GitLab Project ID**: Automatically available as `CI_PROJECT_ID` in GitLab CI/CD
328328
3. **Commit SHA**: Use `CI_COMMIT_SHA` for regular commits, or `CI_MERGE_REQUEST_SHA` for merge requests
329329
4. **GitLab API URL**: Construct as `https://gitlab.com/api/v4/projects/{projectId}/statuses/{commitId}`
330-
5. **Exec Command**: Use `npx smartui exec --gitURL "${GIT_URL}" -- <your-test-command>`
330+
5. **Exec Command**: Use `npx smartui exec --githubURL "${GIT_URL}" -- <your-test-command>`
331331

332332
:::info Understanding the SmartUI Exec Command
333333

334334
The `npx smartui exec` command wraps your test execution and provides SmartUI integration:
335335

336336
```bash
337-
npx smartui exec --gitURL "<gitlab-url>" -- <your-test-command>
337+
npx smartui exec --githubURL "<gitlab-url>" -- <your-test-command>
338338
```
339339

340-
- `--gitURL`: GitLab API URL for status updates (legacy name, works with GitLab)
340+
- `--githubURL`: GitLab API URL for status updates (legacy name, works with GitLab)
341341
- `--`: Separator before your test command
342342
- `<your-test-command>`: Your normal test command (e.g., `npm test`, `mvn test`, `pytest`)
343343

@@ -443,7 +443,7 @@ visual_regression_tests:
443443
echo "GitLab Status URL: ${GIT_URL}"
444444
445445
# Run web tests with SmartUI Exec
446-
npx smartui exec --gitURL "${GIT_URL}" -- npm test
446+
npx smartui exec --githubURL "${GIT_URL}" -- npm test
447447
448448
only:
449449
- merge_requests
@@ -489,7 +489,7 @@ visual_regression_tests:
489489
echo "GitLab Status URL: ${GIT_URL}"
490490
491491
# Run Java tests with SmartUI Exec
492-
npx smartui exec --gitURL "${GIT_URL}" -- mvn test
492+
npx smartui exec --githubURL "${GIT_URL}" -- mvn test
493493
494494
only:
495495
- merge_requests
@@ -537,8 +537,8 @@ visual_regression_tests:
537537
echo "GitLab Status URL: ${GIT_URL}"
538538
539539
# Run mobile tests with SmartUI Exec
540-
npx smartui exec --gitURL "${GIT_URL}" -- npm run test:mobile
541-
# Or: npx smartui exec --gitURL "${GIT_URL}" -- npx wdio run wdio.conf.ts
540+
npx smartui exec --githubURL "${GIT_URL}" -- npm run test:mobile
541+
# Or: npx smartui exec --githubURL "${GIT_URL}" -- npx wdio run wdio.conf.ts
542542
543543
only:
544544
- merge_requests
@@ -584,7 +584,7 @@ visual_regression_tests:
584584
echo "GitLab Status URL: ${GIT_URL}"
585585
586586
# Run Java mobile tests with SmartUI Exec
587-
npx smartui exec --gitURL "${GIT_URL}" -- mvn test -D suite=mobile-tests.xml
587+
npx smartui exec --githubURL "${GIT_URL}" -- mvn test -D suite=mobile-tests.xml
588588
589589
only:
590590
- merge_requests
@@ -610,7 +610,7 @@ visual_regression_tests:
610610

611611
**Solutions**:
612612
1. Verify GitLab integration is active in [LambdaTest Integrations](https://integrations.lambdatest.com/)
613-
2. Check that `--gitURL` parameter is correctly set in the exec command
613+
2. Check that `--githubURL` parameter is correctly set in the exec command
614614
3. Verify GitLab API URL format: `https://gitlab.com/api/v4/projects/{projectId}/statuses/{commitId}`
615615
4. Ensure `CI_PROJECT_ID` and `CI_COMMIT_SHA` are correctly set
616616
5. For merge requests, use `CI_MERGE_REQUEST_SHA` instead of `CI_COMMIT_SHA`
@@ -658,10 +658,10 @@ visual_regression_tests:
658658

659659
| Aspect | SmartUI Exec (This Guide) | SmartUI Hooks |
660660
|--------|---------------------------|---------------|
661-
| **Command** | Use `npx smartui exec --gitURL <url> -- <command>` | Run tests normally (`npm test`, `mvn test`, `pytest`) |
661+
| **Command** | Use `npx smartui exec --githubURL <url> -- <command>` | Run tests normally (`npm test`, `mvn test`, `pytest`) |
662662
| **Integration** | Requires CLI wrapper | Automatic via capabilities |
663663
| **Setup** | Install SmartUI CLI, configure `.smartui.json` | Add capabilities to test config |
664-
| **GitLab Integration** | Use `--gitURL` parameter with exec | Add `github.url` capability |
664+
| **GitLab Integration** | Use `--githubURL` parameter with exec | Add `github.url` capability with `GITHUB_URL` |
665665
| **Languages** | Java SDK, CLI projects, all frameworks | TypeScript/JS/Java/Python/Ruby/C#/WebdriverIO/Appium |
666666
| **Project Token** | Required (`PROJECT_TOKEN`) | Not required (uses `LT_USERNAME`/`LT_ACCESS_KEY`) |
667667
| **Server Address** | May need `SMARTUI_SERVER_ADDRESS` for non-Selenium | Not required |
@@ -671,7 +671,6 @@ visual_regression_tests:
671671
## Next Steps
672672

673673
- Learn about [SmartUI CLI Exec Commands](/support/docs/smartui-cli-exec) for detailed exec usage
674-
- Explore [SmartUI Best Practices](/support/docs/smartui-best-practices) for efficient visual testing workflows
675674
- Check the [SmartUI Troubleshooting Guide](/support/docs/smartui-troubleshooting-guide/) for common issues
676675
- Review [GitLab CI/CD Documentation](https://docs.gitlab.com/ee/ci/) for advanced pipeline configuration
677676

0 commit comments

Comments
 (0)