From da6d020b7541728e7ccdc430faf6c425962e58d3 Mon Sep 17 00:00:00 2001 From: Melissa Kaulfuss Date: Wed, 8 Mar 2023 16:22:06 -0800 Subject: [PATCH] Break out branch limiting instructions As per feedback from @timriley, I propose moving the optional branch limiting filter to it's own section. Github Merge Queues will work out of the box with the first steps, users only need to add the filter pattern if they already have existing branch limiting filters. --- pages/tutorials/github_merge_queue.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/pages/tutorials/github_merge_queue.md b/pages/tutorials/github_merge_queue.md index a4cb7334226..a1f1d6d27c2 100644 --- a/pages/tutorials/github_merge_queue.md +++ b/pages/tutorials/github_merge_queue.md @@ -16,6 +16,12 @@ The merge queue creates temporary branches with a special prefix to validate pul To enable a merge queue for a pipeline: +1. From your Buildkite dashboard, select your pipeline. +1. Select _Pipeline Settings_ > _GitHub_. +1. In the _GitHub Settings_ section, select the _Skip builds with existing commits_ checkbox. + +If you have existing branch limiting rules: + 1. From your Buildkite dashboard, select your pipeline. 1. Select _Pipeline Settings_ > _GitHub_. 1. In the _Branch Limiting_ section, add a filter for the following pattern: @@ -24,6 +30,4 @@ To enable a merge queue for a pipeline: gh-readonly-queue/{base_branch}/* ``` -1. In the _GitHub Settings_ section, select the _Skip builds with existing commits_ checkbox. - That's it! Your pipeline supports merge queues in GitHub. 🎉