preview-workers: the pilot checks for the first lecture repository that adopts it

Open
  • Is something wrong?
#299 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github, github-actions, shell
Domain
ci-cd, devops

Research direction

Start by reading #298's preview-workers action, the canary workflow, and scripts/preview-decide.sh; the issue names these entry points and the pilot checks. Work through the five checks with the first lecture repository that adopts the action, including limits, retention, racing uploads, and the trust gate. Done means the listed checks are resolved and documented; Access gating is optional.

Written by the indexing model from the issue text.

Description

enhancement

preview-workers (#298, for #145) previews a pull request on a Cloudflare Worker. It is tested in this repository's harness, which has no Cloudflare account, and on the canary's own Worker, qe-preview-canary. Five things in #145's "Verify during pilot" list can only be checked once a real lecture repository uses it. The maintainer decided on 2026-11-10 that #145 closes with the action, and these move here for the first lecture repository that adopts it.

  • Limits per Worker version. Static assets have a file-count limit and a 25 MiB per-file limit per version. Check them against the largest site's _build/html. It's unclear whether Workers got the larger file count that Pages received in January 2026. The lecture sites publish through GitHub's Pages deploy, so no gh-pages tree exists to count from here.
  • Version retention. How long old versions and their aliased URLs persist, and how they are pruned. This differs from Pages deployments.
  • Alias stability across many pushes to one pull request, and what happens when two uploads race. The concurrency cancellation from #92's phase 1 should be in the repository's workflow first.
  • The trust gate on a real repository. Fork and Dependabot pull requests must deploy nothing, as with the other two preview actions (scripts/preview-decide.sh).
  • Optional: Cloudflare Access in front of preview URLs, which works on workers.dev previews, for a repository that needs gated drafts. preview-workers has no visibility input for now. Adding the check later, as an input that defaults to off, would break no caller.

The canary run of #298 covers a pull request's placeholder and deploy, a second push to the same alias, a dispatch alias, and a wrong account-subdomain failing, on one small site. It doesn't cover the items above.

Claude Code (on behalf of mmcky), organiser session

Dominant language
Shell
Stars
0
Forks
1
Avg merge
20h 3m
Merged PRs (30d)
48

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from QuantEcon/actions

All issues in QuantEcon/actions

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.