Configuring Merge Queue on GitHub for Branch Protection

  • EasyCLA is a tool that automates the enforcement of Contributor License Agreements (CLAs) in open-source projects.

  • The tool integrates with GitHub and other platforms to verify CLA compliance automatically.

  • To enable this feature, EasyCLA App will need read-only access to the Merge Queue. This permission is essential for the proper functioning of the integration.

Importance of Using a Merge Queue for Controlled PR Merging

  • Merge Queue helps streamline the process of merging pull requests (PRs) in a controlled and efficient manner.

  • It ensures that PRs are merged in a sequential order, reducing conflicts and maintaining code stability.

  • The feature automatically revalidates PRs against the latest branch state before merging, preventing integration failures.

  • Helps maintain a clean and stable main branch, especially in high-collaboration projects.

  • Reduces manual intervention and accelerates the CI/CD pipeline by handling multiple PRs systematically.

Pre-requisites

  • GitHub organization with administrative access.

  • EasyCLA GitHub App installed and configured.

  • Repository branch protection rules available.

Enabling EasyCLA Permissions

To ensure that the feature works correctly, you must approve the required permissions for the EasyCLA app.

If these permissions are not accepted, you may see an "Expected" status for the EasyCLA check in the Merge Queue, preventing the pull request from merging.

To enable the feature, follow these steps:

  1. Access GitHub organization.

  2. Select Settings.

  3. Select GitHub Apps.

  4. EasyCLA will show an update pending:

  1. Select Review request link.

  2. Accept the permissions:

  1. Before proceeding, check the EasyCLA app and confirm that there are no pending permission requests.

    • If there are pending permissions, they should be approved to ensure Merge Queue correct functionality with EasyCLA.

    • If no permissions are pending, proceed to Enabling Merge Queue on GitHub.

Enabling Merge Queue on GitHub

  1. Navigate to the GitHub organization repository.

  2. Go to Settings → Branches.

  1. Click Add rule under Branch protection rules.

  1. On the next page, complete following steps:

  • Add Branch name pattern

  • Click Require a pull request before merging checkbox

  • Click Require status checks to pass before merging and select EasyCLA.

  • Click Require merge queue and update the settings.

  • Click Create.

For more information, see managing a merge queue.

Merging a Pull Request Using Merge Queue

For more information, see Merging a pull request using merge queue.

PreviousReview and sign a Corporate CLA by RequestNextGlossary

Last updated

Was this helpful?