diff options
| author | Drew DeVault <sir@cmpwn.com> | 2018-11-06 08:09:10 -0500 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2018-11-06 08:09:10 -0500 |
| commit | 784bf1c5815d72e749908882aea27441303e75f7 (patch) | |
| tree | 93d7640000bf1717adc2419e3ea762c02d30f701 | |
| parent | 03440ab00fead4312e7ac17b5b1b549262a9efcc (diff) | |
| download | sr.ht-docs-784bf1c5815d72e749908882aea27441303e75f7.tar.gz | |
Add dispatch.sr.ht docs
| -rw-r--r-- | dispatch.sr.ht/github.md | 30 | ||||
| -rw-r--r-- | dispatch.sr.ht/index.md | 17 |
2 files changed, 47 insertions, 0 deletions
diff --git a/dispatch.sr.ht/github.md b/dispatch.sr.ht/github.md new file mode 100644 index 0000000..be41ad2 --- /dev/null +++ b/dispatch.sr.ht/github.md @@ -0,0 +1,30 @@ +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. + + + +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. + + diff --git a/dispatch.sr.ht/index.md b/dispatch.sr.ht/index.md new file mode 100644 index 0000000..bbb6c22 --- /dev/null +++ b/dispatch.sr.ht/index.md @@ -0,0 +1,17 @@ +[dispatch.sr.ht](https://dispatch.sr.ht) is a service on sr.ht that can be used +to automate tasks in response to various events. It's often used, for example, +to automate the submission of builds.sr.ht jobs in response to, for example, git +commits. It's designed to support many other automations as well. + +# Dashboard + +On the dashboard we see a searchable list of your configured tasks. Clicking +each task will take you to a settings page. On the left is the "Configure new +task" button, used for that purpose. + +# Configuring new tasks + +The list of available tasks is shown on the [task configuration +page](https://dispatch.sr.ht/configure). Select a task to configure it, and you +will be taken to a task-specific configuration page. Documentation for each task +is available on these pages. |