← Recipes

阅读中文版本

Spin Up a Dynamic Review Environment per PR

Create an ephemeral namespace per pull request so reviewers can test the change before merge, then tear it down on close.

~35 mincikubernetesreview-env

Task

Automate kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f - so pipeline failures are caught before merge and never reach production.

When to use this

A pull request merges with a broken kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f - step because the workflow did not gate on it, causing a failed deploy.

Prerequisites

  • Node.js 22 and pnpm available
  • A CI workflow file in .github/workflows

Steps

1. Configure kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f - in the project configuration file with the recommended defaults.

kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f -

Expected output: The configuration is accepted and kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f - runs without errors on the first invocation.

2. Run the check locally to verify kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f - produces the expected result before pushing.

act -j build  # or: pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f - blocks merge on failure.

- name: Run add dynamic environment spinup
  run: pnpm test

Expected output: Pull requests with failing kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f - are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Gate the pipeline before merge

Start by measuring the problem. Create an ephemeral namespace per pull request so reviewers can test the change before merge, then tear it down on close. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run kubectl create namespace pr-${{ github.event.number }} –dry-run=client -o yaml | kubectl apply -f - against the current codebase and inspect the output before wiring it into CI.

kubectl create namespace pr-${{ github.event.number }} --dry-run=client -o yaml | kubectl apply -f -

Make failures actionable

Once the gate is in place, make failures actionable. A failing kubectl create namespace pr-${{ github.event.number }} –dry-run=client -o yaml | kubectl apply -f - should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.