diff options
| -rw-r--r-- | dispatch.sr.ht/github.md | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/dispatch.sr.ht/github.md b/dispatch.sr.ht/github.md index d32d38c..55e6fc4 100644 --- a/dispatch.sr.ht/github.md +++ b/dispatch.sr.ht/github.md @@ -5,34 +5,6 @@ title: GitHub integration dispatch.sr.ht supports various integrations with [GitHub](https://github.com). 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. - - - -Select "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: - - - -**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. - - - # Build environment dispatch.sr.ht will check out the specific commit you pushed when submitting @@ -60,3 +32,31 @@ The following environment variables are set when building pull requests: - `GITHUB_PR_TITLE`: the title of the pull request - `GITHUB_BASE_REPO`: the full name (e.g. "username/repo_name") of the base repo - `GITHUB_HEAD_REPO`: the full name (e.g. "username/repo_name") of the head repo (fork) + +# 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. + + + +Select "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: + + + +**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. + + |