Break out branch limiting instructions #1929
Conversation
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.
|
Your Render PR Server URL is https://bk-docs-pr-1929.onrender.com. Follow its progress at https://dashboard.render.com/web/srv-cg4idejhp8u5u0hh4nqg. |
github-actions
bot
added
the
pipelines
timriley
left a comment
timriley
left a comment
There was a problem hiding this comment.
This looks good to me, @MelissaKaulfuss!
mbelton-buildkite
left a comment
mbelton-buildkite
left a comment
There was a problem hiding this comment.
One suggestion to avoid repetition, and an update to the intro paragraph to match the change.
|
|
||
| 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: |
There was a problem hiding this comment.
It would be good to avoid having to repeat the navigation instructions. What do you think about keeping it as one list, but outlining when you need to make changes to the branch limiting rules? Thinking:
| 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: | |
| 1. In the _Branch Limiting_ section, check whether there are any existing branch filter patterns. | |
| - If none, you don't need to do anything further. | |
| - If there are existing patterns, add a filter for the following pattern: |
| gh-readonly-queue/{base_branch}/* | ||
| ``` |
There was a problem hiding this comment.
If using my suggestion to keep one list, you'll need to update the indentation here:
| gh-readonly-queue/{base_branch}/* | |
| ``` | |
| gh-readonly-queue/{base_branch}/* | |
| ``` |
Note, the line above also needs updating to match, but I can't comment on it.
| ## Enable a merge queue for a pipeline | ||
|
|
||
| The merge queue creates temporary branches with a special prefix to validate pull request changes. You need to update the pipeline configuration to match branches with the special prefix. To avoid these temporary branches triggering multiple builds on the same pipeline for the same commit, we recommend enabling the option to skip builds on existing commits. | ||
|
|
There was a problem hiding this comment.
I can't comment on it, but let's update the ordering of the intro paragraph for the steps on line 15 to align with the updated instructions. Thinking:
The merge queue creates temporary branches with a special prefix to validate pull request changes. To avoid these temporary branches triggering multiple builds on the same pipeline for the same commit, we recommend enabling the option to skip builds on existing commits.
If you already use branch limiting rules in the pipeline, you must also add a filter to match branches with the special prefix.
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.