Closed adamhenson closed 2 years ago
This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.
🔍 Inspect: https://vercel.com/foo-software/lighthouse-check-action/F14ca4V6ECn2rYqXpKRBBnsfqj2q
✅ Preview: https://lighthouse-check-action-git-feat-refactor-api-foo-software.vercel.app
Summary
Renamed some
inputs
to make this GitHub Action easier to navigate. Reduced README to summarize things and link to the new documentation website. AddedurlsJson
input.Changes
Renamed some
inputs
as follows. No breaking changes (we still support legacy naming).accessToken
=>gitHubAccessToken
apiToken
=>fooApiToken
author
=>gitAuthor
branch
=>gitBranch
emulatedFormFactor
=>device
(which is also now supported when running against Foo's API)urlsJson
string | undefined
string[] | [string, string][]
An alternative way of passing URLs to Lighthouse Check (instead of
urls
) to fulfill more advanced cases in which URLs have commas or you need to associate a URL with a Foo page token. See examples.Simple example payload. This could be handy if you have commas in your URLs and therefore using
urls
input would be too tricky.A more complex example below is if you're running Lighthouse via foo.software by passing
fooApiToken
and you want to associate pages you've added on Foo with temporary URLs using an ephemeral provided by a service like Vercel. The parsedurlsJson
value can be an array of strings or an array of string tuples. The first value of the tuple should be the Foo page API token and the second value will be the alternative URL. See the Vercel example.