Skip to content

Improves documented description of BranchRuleType

Joe Woodward requested to merge docs/improve-graphql-description-branch-rules into master

What does this MR do and why?

Improves documented description of BranchRuleType

The description for BranchRuleType was describing a list but the description should be for each object.

Also clarifies the name field's description as this field is used not just for specific branch names or wildcard names, it is also used for All branches and All protected branches so we've decided to relabel the value in the UI Rule Target. The new description better reflects this line of thinking.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Edited by Joe Woodward

Merge request reports