Branch protection rules

[ravi-dd]

Hey all,

I'm looking to see how folks are setting branch protection rules with stack-pr. Normally, we only have branch rules on master, meaning that you need a PR with a certain number of approvers to commit to this branch.

master <- A <- B <- C.

Stack-pr will create different branches for each of these. Landing A requires an approval. However, landing B & C technically don't.

[AmaranthineCodices]

Your branch protection rules will still apply, but there may be some issues depending on how they're configured and the order in which PRs are merged.

When used as intended, stack-pr will land the PRs one after another. GitHub will automatically change the targets to master as appropriate. Your branch protection rules will apply to each PR as they target master, so each stacked PR will have to be reviewed and approved before it lands.

If you manually merge PR B or C into their parent branch, those changes will become part of their parent PR and will be subject to branch protection rules as they are being merged with master. I would suggest not trying to restrict this further, because this isn't a fundamentally dangerous action in the presence of branch protection rules - it's analogous to adding another commit onto a PR.

There is an edge case if your branch protection rules are configured to not require re-approval when PRs are updated. If PR A is approved for merge, but then before it's merged the author merges PR B into A, those changes would theoretically be un-reviewed...but this is achievable just by pushing more commits to A's branch as well. That's a trade-off inherent to branch protection rules, unfortunately.