← MergifyCONTENT HISTORY

Update to Mergify

Snapshot Sep 30, 2026 · 23:16 UTC · version 1.0.0

Collection source: not recorded for this historical snapshot.

WHAT CHANGED · RULE-BASED ANALYSIS

First saved snapshot

No earlier snapshot is available to establish a change.

Compare saved observations

Download comparison JSON
Full technical diff · 0 changed fields
Full snapshot data
{
  "description": "Use Mergify config commands to validate configuration files, simulate Mergify actions, and write Mergify configuration. ALWAYS use this skill when validating, writing, editing, or simulating Mergify config. Triggers on config validate, config simulate, mergify configuration, mergify.yml, .mergify.yml, merge queue config, workflow rules, conditions.",
  "included_files": [],
  "name": "mergify-config",
  "skill_md_contents": "---\nname: mergify-config\ndescription: Use Mergify config commands to validate configuration files, simulate Mergify actions, and write Mergify configuration. ALWAYS use this skill when validating, writing, editing, or simulating Mergify config. Triggers on config validate, config simulate, mergify configuration, mergify.yml, .mergify.yml, merge queue config, workflow rules, conditions.\n---\n\n# Mergify Configuration Management\n\n## Overview\n\nThe `mergify config` command group provides tools for validating Mergify configuration files against the official schema and simulating what Mergify would do on a specific pull request using a local configuration file.\n\n## Commands\n\n```bash\nmergify config validate                              # Validate the configuration file\nmergify config simulate PULL_REQUEST_URL             # Simulate actions on a PR\n```\n\n## Configuration File Detection\n\nMergify CLI auto-detects the configuration file from standard locations:\n- `.mergify.yml`\n- `.mergify/config.yml`\n- `.github/mergify.yml`\n\nOverride with `--config-file` / `-f`:\n```bash\nmergify config -f path/to/config.yml validate\n```\n\n## Validating Configuration (`validate`)\n\nValidates the Mergify configuration file against the official JSON schema fetched from `https://docs.mergify.com/mergify-configuration-schema.json`.\n\n```bash\n# Validate auto-detected config file\nmergify config validate\n\n# Validate a specific file\nmergify config -f .mergify.yml validate\n```\n\n**Output:**\n- If valid: prints a success message and exits with code 0\n- If invalid: prints the number of errors and each error's path and message, then exits with code 1\n\n**Use in CI:**\n```yaml\n- name: Validate Mergify config\n  run: mergify config validate\n```\n\n## Simulating Actions (`simulate`)\n\nSimulates what Mergify would do on a specific pull request using the local configuration file. This lets you test configuration changes before committing them.\n\n```bash\nmergify config simulate https://github.com/owner/repo/pull/123\n```\n\n**Required arguments:**\n- `PULL_REQUEST_URL` -- Full GitHub URL of the pull request to simulate against\n\n**Options:**\n- `--token` / `-t` (env: `MERGIFY_TOKEN`) -- Mergify credential. Falls back to the credential `mergify auth login` stored, then to `GITHUB_TOKEN` / `gh auth token`, both deprecated for the Mergify API.\n- `--api-url` / `-u` (env: `MERGIFY_API_URL`) -- Mergify API URL (default: `https://api.mergify.com`)\n\n**Output:** Shows a title and detailed Markdown summary of what actions Mergify would take on the PR with the local configuration.\n\n## Writing and Editing Configuration\n\nWhen helping a user write, edit, or understand a Mergify configuration file,\n**always fetch the relevant documentation pages first**. Do not rely on\nmemorized knowledge -- the configuration format, available actions, and\nconditions syntax evolve over time.\n\n### Documentation index\n\nFetch `https://docs.mergify.com/llms.txt` to get the full documentation index\nwith all available pages and their descriptions.\n\n### Key reference pages\n\nFetch the pages relevant to the user's request before writing any configuration:\n\n| Topic | URL |\n|-------|-----|\n| File format and structure | `https://docs.mergify.com/configuration/file-format` |\n| Conditions syntax and attributes | `https://docs.mergify.com/configuration/conditions` |\n| Data types (duration, templates) | `https://docs.mergify.com/configuration/data-types` |\n| Configuration sharing and reuse | `https://docs.mergify.com/configuration/sharing` |\n| Workflow automation overview | `https://docs.mergify.com/workflow` |\n| All available actions | `https://docs.mergify.com/workflow/actions` |\n| Writing your first rule | `https://docs.mergify.com/workflow/writing-your-first-rule` |\n| Merge queue rules | `https://docs.mergify.com/merge-queue/rules` |\n| Merge queue setup | `https://docs.mergify.com/merge-queue/setup` |\n| Queue priority rules | `https://docs.mergify.com/merge-queue/priority` |\n| Merge protections | `https://docs.mergify.com/merge-protections/setup` |\n| Custom protection rules | `https://docs.mergify.com/merge-protections/custom-rules` |\n| Merge protection examples | `https://docs.mergify.com/merge-protections/examples` |\n| Commands and restrictions | `https://docs.mergify.com/commands` |\n| JSON Schema | `https://docs.mergify.com/mergify-configuration-schema.json` |\n\nFor individual actions (assign, backport, close, comment, copy, dismiss_reviews,\nedit, github_actions, label, merge, queue, rebase, request_reviews, review,\nsquash, update), fetch the specific action page at\n`https://docs.mergify.com/workflow/actions/<action_name>`.\n\n### Workflow\n\n1. **Read the user's existing config** (if any) to understand current state\n2. **Fetch the relevant doc pages** for the features the user needs\n3. **Write or update the configuration** based on the documentation\n4. **Validate**: run `mergify config validate` to check for errors\n5. **Simulate** (optional): run `mergify config simulate <PR_URL>` against a\n   real PR to verify the rules behave as expected\n\n## Common Patterns\n\n### Test config changes before pushing\n```bash\n# Edit your .mergify.yml locally, then:\nmergify config validate\nmergify config simulate https://github.com/myorg/myrepo/pull/42\n# If both look good, commit and push\n```\n\n### CI validation gate\n```yaml\njobs:\n  validate-mergify:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - name: Install mergify-cli\n        run: pip install mergify-cli\n      - name: Validate Mergify config\n        run: mergify config validate\n```\n"
}

SHA-256 of public snapshot: ab1bb4e95fb1774c959e8f8ceb8f22acd399dcc91da641411d76ead10c649f10