Run Playwright / Argos CI in response to a GitHub deployment_status event

[wereHamster]

I'm trying to run Playwright / Argos CI after the website is deployed on Vercel. Vercel will post back to GitHub a deployment_status event which contains the URL. So I know against which URL to run. I also know the git commit (sha). I don't have a branch though (since the commit may be in many branches). It seems that the Argos CI integration requires a branch, playwright is failing with this error:

Error: branch: must be of type String
    at Object.validate (/home/runner/work/stories/stories/node_modules/.pnpm/[email protected]/node_modules/convict/src/main.js:679:17)
    at readConfig (file:///home/runner/work/stories/stories/node_modules/.pnpm/@[email protected]/node_modules/@argos-ci/core/dist/index.mjs:437:12)
    at getConfigFromOptions (file:///home/runner/work/stories/stories/node_modules/.pnpm/@[email protected]/node_modules/@argos-ci/core/dist/index.mjs:585:20)
    at upload (file:///home/runner/work/stories/stories/node_modules/.pnpm/@[email protected]/node_modules/@argos-ci/core/dist/index.mjs:618:20)
    at ArgosReporter.onEnd (file:///home/runner/work/stories/stories/node_modules/.pnpm/@[email protected]/node_modules/@argos-

Is there a way to fake or override the branch name via config option or environment?

[jsfez]

Hello,
You will be able to set the branch by adding ARGOS_BRANCH=your-branch as an environnement variable.

Considering the way you want to use Argos, I would suggest to write ARGOS_BRANCH=main if your reference branch is called main.

[rosskhanas]

@jsfez I have the same error. I can't run Playwrite with Argos on CI at all. I tried to pass ARGOS_BRANCH and no luck.

What is that ARGOS_BRANCH variable? I can't find it documented anywhere. I try to pass master, but I'm not even sure if that suppose to be master or a branch I'm testing... But it does not work anyway.

[jsfez]

Hello @rosskhanas, we should have a call so I can help you. Can you come on Argos' Discord or do you prefer a Meet ?

[rosskhanas]

@jsfez I just accepted the Discord invitation 😃

[gregberge]

We have built-in support for Vercel Preview Deployments (and other providers too) in the latest version of our SDKs. Read our dedicated guide for more information.