Add merge_queue setting to repos

[laurafitzgerald]

Changes Required

Configuration Changes

Under any .github/workflows/ files that contain checks that are required to be retested after addition to the merge queue add the following. Note - if you are not sure which ones, check any that are triggered on.push_request_target: main

Add the following to on

merge_group:
    types: [checks_requested]
workflow_dispatch:

If you are using path_ignores or path to skip jobs based on specified directories or files
Under jobs add the following pre-job to the top of the list of jobs

pre-job:
    runs-on: ubuntu-latest
    name: Pre job checks
    outputs:
      should_skip: ${{ steps.skip_check.outputs.should_skip }}
    steps:
      - uses: actions/checkout@v4
      - id: skip_check
        uses: fkirc/[email protected]
        with:
          cancel_others: false
          paths_ignore: '[<your entries for path_ignores comma separated>]'
          OR
         paths: '[<your entries for path comma separated>]'

Remove the entry for paths_ignores OR path, it is now handled by the pre-job

For each job add the following entry:

    if: needs.pre-job.outputs.should_skip != 'true'
    needs: pre-job

For all workflow files regardless of the use of path_ignore and that contain jobs that need to be retested on addition to the merge queue, to the bottom of the job list add the following:

required-checks:
    name: <Name of Workflow> Required Checks
    # This check adds a list of checks to one job to simplify adding settings to the repo.
    # If a new check is added in this file, and it should be retested on entry to the merge queue,
    # it needs to be added to the list below aka needs: [ existing check 1, existing check 2, new check ].
    needs: [ <your list of checks that should be retested> ]
    if: always()
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: echo '${{ toJSON(needs) }}' | jq -e 'all(.[]; .result == "success" or .result == "skipped")'

Setting Changes

After your pr is merged add the following settings.

Your Repo -> Settings-> Branches -> main -> edit -> Require status checks to pass before merging -> true
-> Status Checks that are required -> Add using the required-checks.name for any that you have added to your workflow files.

It will look something like the following. Pro Tip: search for Required Checks and all your applicable checks should appear in the dropdown

Your Repo -> Settings-> Branches -> main -> edit -> Require merge queue

Repo Checklist

• Kuadrant/dns-operator specifying type to merge_group dns-operator#350 ci: Add "CI Required Checks" job dns-operator#354 Handle skipped checks dns-operator#355
• Kuadrant/kuadrantctl [Eguzki] 🔀 merge queue onboarding kuadrantctl#114
• Kuadrant/kuadrant-operator Merge queue workflow config kuadrant-operator#1138
• Kuadrant/docs.kuadrant.io [@jasonmadigan] Enable GH merge-queue for docs.kuadrant.io docs.kuadrant.io#190
• Kuadrant/authorino-examples
• Kuadrant/testsuite-pipelines
• Kuadrant/limitador [@adam-cattermole] Enable merge queue limitador#413
• Kuadrant/authorino [@KevFan] ci: enable merge_group authorino#524
• Kuadrant/testsuite
• Kuadrant/architecture
• Kuadrant/wasm-shim [@adam-cattermole] Enable merge queue wasm-shim#162
• Kuadrant/limitador-operator [@adam-cattermole] Enable merge queue limitador-operator#177
• Kuadrant/helm-charts
• Kuadrant/kuadrant-console-plugin [@jasonmadigan] Enable GH merge-queue for kuadrant-console-plugin kuadrant-console-plugin#197
• Kuadrant/kuadrant.github.io [@jasonmadigan] Enable GH merge-queue for kuadrant.github.io kuadrant.github.io#74
• Kuadrant/kuadra
• Kuadrant/deployment
• Kuadrant/react-policy-topology
• Kuadrant/gateway-api-state-metrics
• Kuadrant/.github
• Kuadrant/wasm-test-framework
• Kuadrant/authorino-operator [@KevFan] ci: enable merge group authorino-operator#250
• Kuadrant/policy-machinery
• Kuadrant/governance
• Kuadrant/gateway-api-metrics-exporter
• Kuadrant/console-quickstart
• Kuadrant/installation
• Kuadrant/api-quickstart
• Kuadrant/blank-petstore
• Kuadrant/external-dns