piwalker/dolphin
1
0
Fork 0
mirror of https://github.com/dolphin-emu/dolphin.git synced 2024-11-14 21:37:52 -07:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add documentation about Central.

Pierre Bourdon 2014-07-17 03:42:52 -07:00
parent 5be1aee8f4
commit 2553d6216e
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
About-dolphin-emu-bot.md Normal file

@ -0,0 +1,24 @@
@dolphin-emu-bot, aka. irrawaddy, aka. [Dolphin Central](https://github.com/dolphin-emu/sadm/tree/master/central) is a piece of software that controls interaction between our CI system (Buildbot) and GitHub.
## What does it do?
* Automatically builds incoming pull requests authored by trusted developers, and rebuilds on PR updates.
* Updates PR status based on the CI builds/tests results.
* Show updates about GitHub activity on Dolphin's IRC channel.
* Shows updates about (legacy) Google Code activity on Dolphin's IRC channel.
* Provides a way for Dolphin maintainers to allow a PR author to merge their PR by themselves.
## Reverse PR approval workflow
One of the recent additions to @dolphin-emu-bot's features is the ability to make a PR mergeable by its author. The idea behind this feature is to reduce PR review latency by pre-allowing a PR to be merged before it's completely ready. For example, if an otherwise good PR has a typo in documentation, the repo maintainer can comment on this typo asking for a fix, and pre-allow the merge so that the PR author can merge the change themselves after the fix has been applied.
Two commands can be used by Dolphin maintainers in PR comments:
* `@dolphin-emu-bot allowmerge` in a comment will show a link that allows the PR author to merge their change.
* `@dolphin-emu-bot disallowmerge` can be used to override that decision in a later comment.
The last of these two commands in PR comments will determine the status of the PR (author mergeable or not). Default status is, obviously, unmergeable.
## Triggering rebuilds of a PR from an untrusted developer
Just use the `@dolphin-emu-bot rebuild` command in a PR comment. Be careful that the PR does not contain anything dodgy that might get executed on Dolphin's CI infrastructure.