> ## Documentation Index
> Fetch the complete documentation index at: https://docs.theroyalglow.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Mergify

> Merge protections, queues, priorities, labels, CLI, and freezes.

Mergify reads `.mergify.yml` from the default `prod` branch. It is the only merge
orchestrator for this repository.

## Queue policy

Mergify governs reviewed PRs into **dev**. Add `merge-ready` after the required
checks and review pass. Ordinary feature and release PRs are squash-merged.

Environment branches advance through **Promote validated commit**, which uses
fast-forward pushes after CI, CodeQL, integration, and load/security validation.
It preserves exact commit SHAs and messages without promotion PRs. Production
requires explicit production confirmation by katbose at dispatch. Never force-push or
create commits directly on environment branches.

Release Please targets dev; its metadata follows the same promotion path. See
[CI/CD](/engineering/ci-cd) and `knowledge-base/branch-promotions.md` for operation.

## CLI

On this Windows machine the checksum-verified `2026.8.31.1` executable is installed
at `C:\Users\kbose\.local\bin\mergify.exe`. Add `C:\Users\kbose\.local\bin` to the
user `Path` from Windows Environment Variables, then open a new terminal. The
repository never modifies a collaborator's PATH automatically.

Other collaborators should follow Mergify's official installer: Homebrew on macOS,
the official install script on Linux, or the release ZIP plus checksum on Windows.

```bash theme={"theme":{"light":"gruvbox-light-medium","dark":"gruvbox-dark-medium"}}
mergify --version
mergify config validate
mergify config simulate https://github.com/royalglowsalonspa/theroyalglow-webapp/pull/NUMBER
mergify queue status
```

The CLI can reuse `gh auth` for GitHub operations. Queue administration, events,
and freezes accept a GitHub token or a Mergify application key in `MERGIFY_TOKEN`;
never commit either value. CI installs the verified CLI through
`Mergifyio/setup-cli` v1.3.0, pinned to its full commit SHA, only for configuration
changes. The workflow also pins CLI version `2026.8.31.1` for reproducible validation.

This project stores its GitHub MCP token as `GITHUB_PAT_RGSS`. For a local CLI
session, map it without printing the value:

```powershell theme={"theme":{"light":"gruvbox-light-medium","dark":"gruvbox-dark-medium"}}
$env:GITHUB_TOKEN = $env:GITHUB_PAT_RGSS
```

## Freezes

There is intentionally no permanent freeze. Create a time-bounded Mergify freeze
for release stabilization, high-traffic periods, or incidents:

```bash theme={"theme":{"light":"gruvbox-light-medium","dark":"gruvbox-dark-medium"}}
mergify freeze create --reason "Production stabilization" --timezone Asia/Kolkata \
  --start 2026-09-06T18:00:00 --end 2026-09-07T09:00:00 \
  -c "base=prod" -e "label=hotfix"
mergify freeze list
mergify freeze delete FREEZE_ID --reason "Window complete"
```

The `hotfix` exclusion is deliberate. Record the freeze reason and owner in the
incident or release ticket before creating it.

See Mergify's official [configuration](https://docs.mergify.com/configuration/file-format/),
[CLI](https://docs.mergify.com/cli/usage/), and
[freeze](https://docs.mergify.com/merge-protections/freeze/) references.


## Related topics

- [Git Workflow](/content/docs/git-workflow.md)
- [GitHub Rulesets](/github/rulesets.md)
- [CI/CD](/engineering/ci-cd.md)
- [Engineering Workflow](/engineering/index.md)
- [Platform Implementation Report](/engineering/platform-implementation-report.md)