Programmatically toggle Oxygen preview urls as Public / Private

[cmhnk]

I'm using the LighthouseCI Github Action to monitor performance of my Hydrogen site.

Currently the way I'm able to do this is by having two separate jobs within the .github/workflows/oxygen-deployment.yml file. After the deploy job succeeds, I have a lighthouse job that runs Lighthouse on the preview URL from the deploy step.

Because preview URLs are private by default, the first time the lighthouse job runs, it always fails. As a temporary workaround, I thought I could go into Shopify > Channels > Hydrogen and set the preview URL to public, re-run the failed Lighthouse job, then set the preview URL back to private. However, Hydrogen seems to think the Preview Deployment failed and thus I can't set the preview URL to public -- even though the deploy job succeeds and there is indeed a preview URL.

Unable to toggle deployment to public:

But there is a deployment:

The ability to either (a) programmatically login to a preview site (I didn't have luck with browser automation tools like puppeteer because of captchas) or (b) toggle preview URLs privacy settings (ex. via GraphQL API or the shopify-cli) would be very helpful.

If there's a better approach for accessing preview sites in CI/CD, please let me know. Thank you!

[frandiox]

@graygilmore Do you know if there's any way to access preview sites from CI? 🤔

[graygilmore]

For starters: this is a great bug report. The admin should not say that the deployment failed when it's a different job that failed in the action.

We're currently working on some ways to enable tooling like this to work while keeping the deployment private but no timeline I can say on that right now.

Toggling the privacy via CLI could be a good interim option, though. I'll bring that back to the team!

[cmhnk]

@graygilmore would it be helpful if I opened a new Issue with this bug report, or is it captured on your side already?

[graygilmore]

We've got it captured, thanks!