Skip to content
Fwozen
Start free

Docs

Everything, and no signup wall.

Every page here is public and static. If you want to read how the freeze engine behaves before you install anything, that is the correct order.

I’m setting up

Install the app, enable repos, and make the fwozen check actually required.

I want to understand the model

Windows, timezones, precedence, exceptions, and what happens mid-merge-queue.

I’m integrating

The REST API, the deploy gate, Slack, and the MergeFreeze-compatible namespace.

Quickstart

Four commands and one click. This is the whole path from nothing to a branch that cannot be merged to.

  1. Step 1 — install

    Install the GitHub App and pick your repositories. Fwozen asks for seven permissions and none of them can write to your code.

  2. Step 2 — make the check required

    Either let Fwozen write the ruleset with your authorization, or run this yourself:

    Require the fwozen check
    gh api -X POST repos/acme/api-server/rulesets \
  -f name='fwozen' -f target='branch' -f enforcement='active' \
  -F conditions[ref_name][include][]='refs/heads/main' \
  -F rules[][type]='required_status_checks' \
  -F 'rules[][parameters][required_status_checks][][context]=fwozen'

  3. Step 3 — freeze

    Freeze for two minutes
    curl -X POST https://api.fwozen.com/v1/freezes \
  -H "Authorization: Bearer $FWOZEN_TOKEN" \
  -d '{"scope":{"kind":"org"},"reason":"Testing Fwozen","durationMinutes":2}'

  4. Step 4 — check a pull request

    Open any pull request in scope. The fwozen check is failing with your reason on it, and the merge button is disabled. In two minutes it lifts itself.

All pages