View as Markdown

Scopes with Nx

Configure merge queue scopes using Nx's dependency graph to drive batching.

If you’re using tools like the Nx build system that have built-in dependency graph analysis, you can leverage their affected project detection instead of using file patterns. This approach is often more accurate because these tools understand your project’s dependency relationships.

Configuring Manual Scopes

Section titled Configuring Manual Scopes

To use the manual scopes mechanism, configure Mergify to expect scopes from your CI system:

scopes:
  source:
    manual:


queue_rules:
  - name: default
    batch_size: 5

Detecting Scopes with Nx

Section titled Detecting Scopes with Nx

In your GitHub Actions workflow, use the nx show projects command to determine affected projects and upload them to Mergify:

name: Detect Scopes
on:
  pull_request:


jobs:
  detect-scopes:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v5


      - name: Get git refs
        id: refs
        uses: Mergifyio/gha-mergify-ci@v11
        with:
          action: scopes-git-refs


      - name: Get scopes
        id: scopes
        env:
          HEAD: ${{ steps.refs.outputs.head }}
          BASE: ${{ steps.refs.outputs.base }}
        run: |
          scopes=$( npx nx show projects --affected --base=$BASE --head=$HEAD | paste -sd, -)
          echo "scopes=$scopes" >> "$GITHUB_OUTPUT"


      - name: Scopes upload
        uses: Mergifyio/gha-mergify-ci@v11
        with:
          action: scopes-upload
          token: ${{ secrets.MERGIFY_TOKEN }}
          scopes: ${{ steps.scopes.outputs.scopes }}

Was this page helpful?

Edit this page on GitHub