walshydev / cf-pages-await

Wait for your Cloudflare Pages builds to finish!

Hi 👋, I'm Walshy

Fullstack Software Engineer at Cloudflare working on Pages

🧭 Social Links

• Twitter: @WalshyDev
• Email: [email protected]
• Website: walshy.dev

What I do

My day to day is writing Golang and TypeScript/JavaScript. I still write some Java but it's more reviewing these days. Follow me on Twitter to see what I'm doing, I forget to update this.

cf-pages-await's Issues

Main differences from pages-action

Hi, I'm a bit confused when someone might prefer using this versus https://github.com/cloudflare/pages-action. Maybe you could explain a bit in the readme what the differences are?

Accept API Tokens

Users can now use API token with Cloudflare Pages (yay!). This Action currently only accepts global API keys. Let's update to take either and update docs to encourage API token usage?

Check if deployment is skipped/custom timeout

I have my cloudflare pages only set to deploy on dev and main branches, the others are skipped:

However it did trigger my github actions which awaited for the maximum of 6 hours after which github kills the worker:

This ate my free github actions time :/

Either make it fully reliable (it also doesn't work when there are two back to back commits where a CF deployment is queued) OR allow a custom (10 minutes would suffice for me) timeout after which the awaiting stops.

README does not point to Token template

Hey I'm hitting a authentification error and it might be because I did not user the proper template (or overall permission) when I created the token.

Is there any specific direction as to which kind of CloudFlare Token we should create?

Thanks a ton!

"Waiting for the deployment to start" when used in Workflows that create new commits

I'm using this action in a workflow that uses semantic-release to automatically generate release commits.

cf-pages-await uses the variable GITHUB_SHA to refer to the original commit invoking the workflow, but my latest commit is always newer because of semantic-release. So it "[waits] for the deployment to start" forever.

It would be nice to have the ability to toggle whether this action checks for a commit match or just wait for the latest build blindly.

My solution to this for now is to rearrange my action so that I wait for the Cloudflare Pages build first, do my post-build tasks, then run the release. No big deal at all.

This problem would also get naturally solved by support to filter out commits from auto deployment on Cloudflare Pages with, e.g., skip ci in the message.

The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files.

https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

Return outputs on build failure

I am trying to run some GH actions by gathering the CloudFlare build logs (even on build failure).

It seems that at the moment the script is only configured to return outputs in the case the build succeeds.

Would it be possible to add a flag to make it return outputs (like deployment id) on build failure as well?
Not sure if we can access continue-on-error from within the action.

Let me know and I'd be happy to create a PR

Error when GitHub token not provided

The function is called regardless whether the GitHub token is provided or not.

cf-pages-await/src/action.ts

Lines 47 to 52 in 3c88b7e

	if (latestStage.status === 'failed') {
	waiting = false;
	core.setFailed(`Deployment failed on step: ${latestStage.name}!`);
	await updateDeployment(token, deployment, 'failure');
	return;
	}

So it will throw an error from octokit.

Wait for a specfied commit's deployment

Sometimes when I pushed a commit in GitHub Actions to a branch to trigger CF Pages's build, a new deployment won't always be created immediately. I think we should accept a commit ref and check if the ref exists in the deployments array.

Skipping build breaks action

Thank you so much for the action!

Skipping a build by using the commit prefixes specified at https://developers.cloudflare.com/pages/platform/branch-build-controls/#skip-builds causes the action to get stuck:

Waiting for Pages to finish building...
# Now at stage: queued

It doesn't work as dependent on each deployment.

Even when one deployment is finished, it seems to keep waiting when another queued deployment starts.
Even if the deployments in the queue are in succession, can't each work individually?