~sircmpwn/sr.ht-docs

ref: 832495742695ad58609ed93b98963e2a6492a2be sr.ht-docs/dispatch.sr.ht/github.md -rw-r--r-- 1.2 KiB
83249574Drew DeVault Add link to GitHub on GitHub docs 2 years ago

dispatch.sr.ht supports various integrations with GitHub. Some tips are provided here.

#Configuring branch protection rules on GitHub

If you choose the "auto-merge" setting, builds.sr.ht will attempt to merge the pull request once the build completes successfully. You will likely want to add branch protection rules on GitHub to prevent this from happening before the pull request is reviewed.

To edit your branch protection rules, start by visiting "Branches" in your repository's settings.

Screenshot of the "branches" page

Select "Add rule".

Screenshot of "add rule"

Specify the branches you want the rule to apply to (e.g. "master") and configure the criteria which must be met for the pull request to be mergeable. For example, to require the code to be reviewed before merge:

Screenshot of code review settings

Important: if your account is an administrator on this GitHub repository, attempts to merge will succeed even if the branch protection rules are unmet. You must enable the "Include administrators" option to prevent this.

Screenshot of "Include administrators" option