Enable Merge Queue in All Repositories

[dekiel]

Enable Merge Queue in All Repositories

Summary

To enhance our development workflow, we propose enabling GitHub's Merge Queue feature across all our repositories. This will ensure that pull requests (PRs) are merged only after passing all required checks, maintaining the stability of our main branches.

Action Items

1. Enable Merge Queue via Repository Rulesets

• Configure repository rulesets to require a merge queue for the target branches.
• Ensure that merge queue allow PRs with failed CI checks as long as last PR in a queue has all CI checks success.
• Follow GitHub's official guide: Managing a merge queue.

2. Update CI Workflows

• Modify our Continuous Integration (CI) workflows to trigger on the merge_group event.
• This ensures that necessary checks run when a PR is added to the merge queue.

Example GitHub Actions workflow update:

on:
  pull_request:
  merge_group:
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Run tests
        run: ./run-tests.sh

Refer to GitHub’s documentation for details on the merge_group event: Events that trigger workflows.

Acceptance Criteria

• Repository rulesets are updated to require the use of a merge queue for all target branches.
• CI workflows are configured to trigger on the merge_group event.
• PRs are merged only when the last one in the queue has passed all required checks.
• Check how Azure DevOps supports merge_group event.

Benefits of Implementing Merge Queue

• Automated Merging: PRs are automatically merged once they pass all required checks, reducing manual intervention.
• Branch Stability: Ensures that the main branch remains stable by merging only PRs that have passed the necessary checks.
• Improved Collaboration: Streamlines the merging process, allowing team members to focus on development rather than manual merges.

By adopting the Merge Queue feature, we aim to enhance our development process’s efficiency and reliability.

[dekiel]

@Sawthis the requirement to enable a merge queue for use is to add merge_queue event to the workflows triggers.