Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix test.sh usage description #62

Merged
merged 2 commits into from
Sep 3, 2024
Merged

Fix test.sh usage description #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5494f48
**Description**
aws-donocl Aug 30, 2024
faac3ef
Fix test.sh usage description in readme
aws-donocl Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,17 @@ Follow the previous steps to patch and build the project.
Use the `./scripts/test.sh` script for testing.

```
Usage: test.sh --website='<WEBSITE-URL>' [OPTIONS]

Required:
--website='<WEBSITE-URL>' URL of the Code Editor instance to test.
Usage: test.sh [OPTIONS]

Options:
-u|--unit-test Run OSS unit tests.
-i|--integ-test Run OSS integration tests.
-s|--style-check Run OSS style check.
-c|--cypress-integ-test Run Code Editor UI tests.
-l|--local Run Code Editor UI tests against a local instance (requires -c).
-n|--no-patches Skip automatic patching of OSS.
-h|--help Show this help message and exit.
-w '<WEBSITE-URL>'|--website='<WEBSITE_URL>' URL of the Code Editor instance to test (default: http://localhost:9888).
-u|--unit-test Run OSS unit tests.
-i|--integ-test Run OSS integration tests.
-s|--style-check Run OSS style check.
-c|--cypress-integ-test Run Code Editor UI tests.
-l|--local Run Code Editor UI tests against a local instance (requires -c).
-n|--no-patches Skip automatic patching of OSS.
-h|--help Show this help message and exit.
```
***Note***: make sure you have the `'`quotes`'` around the website url.

Expand Down
7 changes: 2 additions & 5 deletions scripts/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@

usage() {
printf """
Usage: $(basename $0) --website='<WEBSITE-URL>' [OPTIONS]

Required:
--website='<WEBSITE-URL>' URL of the Code Editor instance to test.
Usage: $(basename $0) [OPTIONS]

Options:
-w '<WEBSITE-URL>'| --website='<WEBSITE_URL>' URL of the Code Editor instance to test.
-w '<WEBSITE-URL>'|--website='<WEBSITE_URL>' URL of the Code Editor instance to test (default: http://localhost:9888).
-u|--unit-test Run OSS unit tests.
-i|--integ-test Run OSS integration tests.
-s|--style-check Run OSS style check.
Expand Down