This branch builds the RisingWave image Whop runs: an official RisingWave release plus a short list of patches. Nothing else is different. The image is built the same way as the official one (docker/Dockerfile, CARGO_PROFILE=production, as upstream's ci/scripts/docker.sh).
| File | What it is |
|---|---|
patches |
The base release and the patches, in order. |
assemble |
Clones the base release and commits each patch on top of it. |
check |
Runs every check in checks/ against an image. |
checks/<name>/run.sh |
One check per patch: fails if the bug the patch fixes comes back. |
.github/workflows/whop-build.yml |
Assembles, tags, builds, checks and publishes an image. |
.github/workflows/whop-check.yml |
Runs the checks against an image that is already published. |
base v3.1.1
pr risingwavelabs/risingwave#27977 Source backfill no longer loses rows when its Kafka reader reaches a partition EOF
commit whopio/risingwave@<sha> A note
baseis the upstream release tag to start from. Change it to move to a new release.pr <owner>/<repo>#<number>applies the whole diff of a pull request (from any repository, open or merged) as one commit.commit <owner>/<repo>@<sha>applies one commit. For a change of our own, push it to a branch of this repository and list its commit.- The text after the reference is a note for the release page.
assemble reports each line:
| Result | Meaning |
|---|---|
applied |
The patch is in the build. |
in base |
The base release already contains the change. The build goes on; remove the line. |
conflict |
The patch does not apply to the base. The build stops. Rebase the change onto the base release, push it as a commit to this repository and list that commit. |
The last commit of every build removes .github/workflows, so upstream's workflows never run in this repository. It does not change the binary.
Check a list before you build:
./assemble /tmp/risingwave-patchedIt needs gh with access to the listed repositories.
Run Build patched RisingWave on this branch (Actions tab, or gh workflow run whop-build.yml --repo whopio/risingwave --ref whop). It:
- assembles the patched tree and pushes it as tag
<base>-whop.<n>, with the patch list as the tag message; - builds the image on an ARM runner (prod runs on ARM64 only), checks that it starts, runs
./checkagainst it, and only then pushesghcr.io/whopio/risingwave:<tag>; - publishes a release with the patch list and the image pinned by digest (
ghcr.io/whopio/risingwave@sha256:...), the string prod uses.
The image is linux/arm64 only. On an x86 machine, run it with emulation (--platform linux/arm64) or test with the official image of the base release.
SELECT version() on a running node shows the commit of that tag.
A check is a directory under checks/ with a run.sh that reads the image from RW_IMAGE and exits non-zero when the bug is back. checks/source-backfill-handoff-loss replays risingwavelabs#27976: on the official v3.1.1 image it loses 99 of 100 rows and fails.
./check ghcr.io/whopio/risingwave:v3.1.1-whop.1The images are ARM64, so run checks on an ARM machine, or run Check a patched RisingWave image in Actions. The checks need Docker and uv.
Org-wide roles give many people write access to this repository, so rules decide what they can do:
| Rule | Effect |
|---|---|
| Ruleset "Only org admins push branches" | Only org admins create, push to or delete any branch. |
Protection on whop |
Only jjantschulev pushes to or merges into whop, admins included. |
| Ruleset "Only org admins and the build deploy key push tags" | Only org admins and the build's deploy key create, move or delete tags. |
Environment build |
Only runs on whop can read BUILD_DEPLOY_KEY, the deploy key that pushes build tags. |
if: github.actor == 'jjantschulev' in the workflow |
Only jjantschulev starts a build. |
Prod should pin the image by digest (ghcr.io/whopio/risingwave:<tag>@sha256:...), because anyone with write access to this repository can push to its package.
Prod pins the image in the monorepo: RISINGWAVE_IMAGE in infra/pulumi/src/risingwave/nodes.ts. Set it to the pinned image from the release page. To go back to the official image, set it back to ghcr.io/risingwavelabs/risingwave:<base>. This works because patches change behavior only.
- Keep a patch to behavior. Do not change files under
proto/, meta migrations or how state is stored, so the official image of the same release can always replace ours. - Give a patch a check under
checks/when its bug can be reproduced.