update readme

README.md

@@ -10,15 +10,16 @@
 - name: Dispatch for tests
   uses: empirical-run/dispatch-action@main
   with:
+    environment: production # or staging or mobile
     build-url: ${{ steps.prev-step.outputs.url }}
-    platform: web  # or android, ios
 ```
 
 Supported inputs
+
+- [x] environment: **Required** input, to specify which environment to run the tests against. Configure environments by contacting us.
 - [x] build-url: **Required** input, for the URL of the application build
-   - For web, this points to a URL of the deployment (e.g. `https://staging.your-app.com`)
-   - For mobile, this points to a downloadable file, ending in `.apk`, `.aab` or `.ipa`
-- [x] platform: **Optional** input, to specify one of the supported platforms: `web`, `android`, or `ios`. Default is `web`
+  - For web, this points to a URL of the deployment (e.g. `https://staging.your-app.com`)
+  - For mobile, this points to a downloadable file, ending in `.apk`, `.aab` or `.ipa`
 
 > Note that this Action only supports whitelisted GitHub organizations. To get access, contact us.
 

src/main.ts

@@ -53,10 +53,14 @@ export async function run(): Promise<void> {
       console.log(`Warning: slack-webhook-url is not a supported input, and will be ignored.`)
     }
     const platform: string = core.getInput('platform');
-    if (platform && !isValidPlatform(platform)) {
-      core.setFailed(`Invalid config: platform must be one of web, android or ios.`)
+    if (platform) {
+      console.warn(`Warning: platform is a deprecated input, you should use environment instead.`)
     }
+
     const environment = core.getInput('environment');
+    if (!platform && !environment) {
+      core.setFailed(`Missing config parameter: either of "environment" or "platform" (deprecated) needs to passed`)
+    }
 
     const response = await fetch("https://dispatch.empirical.run/v1/trigger", {
       method: "POST",