Skip to content

Commit

Permalink
Cleanup README Example (#67)
Browse files Browse the repository at this point in the history
* Cleanup README Example
  • Loading branch information
twistedpair authored Jan 10, 2025
1 parent ff01375 commit 87ad254
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
with:
application-id: <your-application-id-a>
environment-id: <your-environment-id-e>
uri: <your-override-url>
app-url: <your-webapp-override-url>
mabl-branch: <your-mabl-branch-name>
# Runs for both browsers
browser-types: |
Expand Down Expand Up @@ -107,12 +107,12 @@ jobs:
types to test e.g. `chrome, firefox, webkit, edge`. If not
provided, mabl will test the browsers configured on the triggered test.
- `plan-labels` {string} (optional): comma or new line separated plan labels to test. Plans matching **any** label will be run. e.g. `smoke-test, beta-feature`. Note: additional selection criteria must also be met like application-id or environment-id, if supplied.
- `uri` {string} (optional, DEPRECATED - use app_url) the base uri to run browser based tests against. If provided, this will
override the default uri associated with the environment in mabl
- `app-url` {string} (optional) the base uri to run **Web Browser tests** against. If provided, this will
override the default web browser uri associated with the environment in mabl (note, this replaces `uri`, and will supersede the value in `uri` if both are provided)
- `api-url` {string} (optional) the base uri to run **API tests** against. If provided, this will
override the default API uri associated with the environment in mabl
- `uri` {string} (optional, DEPRECATED - use app_url) the base URL to run browser based tests against. If provided, this will
override the default URL associated with the environment in mabl
- `app-url` {string} (optional) the base URL to run **Web Browser tests** against. If provided, this will
override the default web browser URL associated with the environment in mabl (note, this replaces `uri`, and will supersede the value in `uri` if both are provided)
- `api-url` {string} (optional) the base URL to run **API tests** against. If provided, this will
override the default API URL associated with the environment in mabl
- `mabl-branch` {string} (optional) run tests on the mabl branch of tests with this name. Defaults to `master`.
- `http-headers` {string} (optional) Headers to add to all requests e.g. "My-Header:the-value" (comma or new line delimited).
- `rebaseline-images` {boolean} (optional) - Set `true` to reset the visual
Expand Down
8 changes: 4 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ inputs:
required: false
app-url:
description: ^
'The base uri to run WEB BROWSER TESTS against. If provided, this will
override the default web browser uri associated with the environment in mabl (note, this replaces `uri`, and will override the value in `uri` if both are provided)'
'The base URL to run WEB BROWSER TESTS against. If provided, this will
override the default web browser URL associated with the environment in mabl (note, this replaces `uri`, and will override the value in `uri` if both are provided)'
required: false
api-url:
description: ^
'The base uri to run API TESTS against. If provided, this will
override the default API uri associated with the environment in mabl'
'The base URL to run API TESTS against. If provided, this will
override the default API URL associated with the environment in mabl'
required: false
mabl-branch:
description: ^
Expand Down

0 comments on commit 87ad254

Please sign in to comment.