Changes between Initial Version and Version 1 of patchbot

Apr 18, 2022, 3:07:09 AM (6 months ago)
Matthias Köppe

Move here from


  • patchbot

    v1 v1  
     1== The Sage Patchbot ==
     3The patchbot pulls and applies git branches from Trac and can be found at or from links on the individual Trac tickets (round icons at top right).
     5You can help by running your own patchbot. See below for instructions about installation and usage.
     7See a list of some patchbot names and their owners at [[patchbot/owners]].
     9This is still very much a work in progress. The latest version of the code lives at
     11== Lists of reports ==
     13You can see the status of several tickets at the same time (replace xxxx by your user name):
     15For the tickets you participated in, see
     17For the tickets you authored, see
     19=== Ticket Status ===
     21The color of the report page icon indicates the status of the ticket. See the report page itself for more details. The possible statuses are:
     23[[Image(, width=48)]] '''New'''
     25[[Image(, width=48)]] '''Pending''' A patchbot is currently running on this ticket. The patchbot may have stopped if the ticket was deemed unsafe.
     27[[Image(, width=48)]] '''!TestsPassed''' Everything is okay, as far as a patchbot can tell.
     29[[Image(, width=48)]] '''!TestsPassedOnRetry''' Everything is okay, but only after several tentatives.
     31[[Image(, width=48)]] '''!ApplyFailed''' The branch could not be applied. This can be caused by conflicts with other branches or dependencies. Try rebase your branch on the latest develop branch.
     33[[Image(, width=48)]] '''!BuildFailed''' The branch can be applied, but sage failed to build, due to errors in the code. Check the code.
     35[[Image(, width=48)]] '''!TestsFailed''' One or more tests did not succeed.
     37[[Image(, width=48)]] '''!PluginFailed''' Tests have been successfully done, but plugins have found some problems.
     39[[Image(, width=48)]] '''!PluginOnlyFailed''' Plugin have found some problems. Tests have not been made.
     41[[Image(, width=48)]] '''!PluginOnly''' Plugins have found no problem. Tests have not been made.
     43[[Image(, width=48)]] '''!NoPatch''' No branch has been uploaded to Trac so far. The patchbot has nothing to do.
     45[[Image(, width=48)]] '''Spkg''' This is related to an spkg. The patchbot will only check the spkg installation.
     47=== Hints and tricks ===
     49 * To rerun tests (even though the branch was not modified) add the kick parameter, e.g.,
     50== Installing the patchbot ==
     52It is safer to run the patchbot in an unused sage install.
     54||<#FFFF66>① Install the patchbot using '''pip3 install --user git+'''||
     56or using PyPI:
     58||<#FFFF66>① Install the patchbot using '''pip3 install --user sage-patchbot'''||
     61Dependencies: shell commands '''git'''; '''tar'''; '''wget'''
     63'''pyflakes''' and '''pycodestyle''' will be installed by pip if not already installed.
     65||<#98FF98> Please set the --owner option if you run a patchbot. It is useful to know whom to contact.||
     67You can instead register [[patchbot/owners|here]].
     69== Installing optional packages ==
     71You are allowed and in fact even encouraged to install optional packages in sage before running the patchbot. When doing so, please keep in mind that certain optional packages require things outside of sage to be installed.
     72The following list of commands is handy if one wants to install ''all'' optional packages.
     75sage -pip install service_identity
     76apt-get install graphviz pandoc build-essential libxml2 libxml2-dev
     79== Running the patchbot ==
     81Before running the patchbot make sure that the following two commands produce no errors when executed in the root of the sage installation you want to run the patchbot with.
     84    make
     85    ./sage -t --all --long
     88||<#FFFF66>② Run the patchbot using '''python3 -m sage_patchbot.patchbot --sage-root HERE_PATH --owner HERE_NAME'''||
     90The patchbot should be run with '''pip3''' and '''python3'''. The version of Python must be at least 3.7.
     92The '''--sage-root''' parameter is required.
     94Your patchbot will run forever, as long as it finds a ticket to work on.
     96You can let the patchbot choose the tickets it will run on.
     98You can run a specific ticket by using '''--ticket N''' where N is a ticket number such as 12345 (or a sequence such as 12345,23456)
     100Several other options are available, see '''--help'''
     102'''--skip-base''' will skip the check that the base sage installation is sane. Please do not use when running on many tickets.
     104'''--plugin-only''' will only build (sage and the doc) and run the plugins but not the tests (much quicker but less useful).
     106'''--safe-only''' will only test branches that only change files inside the directory "src/sage" (this is the case by default).
     108'''--skip-doc-clean''' the "make doc-clean" is not run during the patchbot initialization. Useful if your machine does not have enough ram to build the documentation in a single round.
     110If the patchbot process receives the signal SIGUSR1 (using {{{kill -s SIGUSR1 pid}}}), it will gracefully stop after finishing its job on the ticket it is currently working on.
     112== Configuration ==
     114By default, the patchbot should run without needing to tune its configuration. You can use a specific configuration file in the json format and run the patchbot with the option
     116--config fullpath/config_file.json
     118The json format mostly looks like a python dictionary. Here is an example of a valid configuration file
     120    {"bonus": {"niceguy": 200, "needs_work": -20},
     121     "use_ccache": false,
     122     "safe_only": true,
     123     "skip_base": true,
     124     "time_of_day": "22-7",
     125     "parallelism": 8
     126    }
     128Note that the booleans must be written with no capital first letter.
     130The config will be read again between every run, hence it allows live configuration of the patchbot.
     132The list of configurable entities are:
     134|| option                    || type            || default       || description                                                                       ||
     135|| ''time_of_day''           || string          || "0-0"         || (example "0-0" or "22-7") an interval of time during which the patchbot is active ||
     136|| ''bonus''                 || dictionary      || ''see below'' || some bonus to influence the order in which tickets are tested (see below)         ||
     137|| ''safe_only''             || boolean         || true          || whether to only test "safe" tickets modifying only src/sage or src/doc            ||
     138|| ''skip_base''             || boolean         || false         || whether to run testlong on the base before testing tickets                        ||
     139|| ''parallelism''           || integer         || 3             || the number of threads to execute when compiling or testing                         ||
     140|| ''idle''                  || integer         || 300           || seconds to wait when network is not working or there are no tickets available     ||
     141|| ''timeout''               || integer         || 10800         ||                                                                                   ||
     142|| ''base_branch''           || string          || develop       || the name of the git branch to synchronized with the develop branch on trac        ||
     143|| ''sage_root''           || string          ||        || the path to the directory containing the sage installation ||
     144|| ''plugins''               || list of strings || ''see below'' || the plugins to use                                                                ||
     145|| ''test_options''               || string         || "" || anything that can be passed to sage -t --optional, for example "sage,external" or "sage,internet"                                            ||
     147=== bonus ===
     149There are two kinds of bonus, the one related to tickets:
     151 * ''logins'' (counted x2 if author and x1 if participant)
     152 * ''component'' (e.g. "linear algebra", "combinatorics", ...)
     153 * ''status'' (e.g. "needs_review", "positive_review", ...)
     154 * ''priority'' (e.g "blocker", "critical", ...)
     156and the one related to other bot reports:
     158 * ''behind'': weight the number of commits behind master
     159          (and count for -1 if the commit is not locally available)
     160 * ''applies'': whether previous bots succeeded when merging the branch with the current beta
     161 * ''unique'' : give less chance for already seen tickets
     163The defaults are
     165 "bonus": {
     166     "blocker"        : 100,
     167     "critical"       : 60,
     168     "major"          : 10,
     169     "minor"          : 0,
     170     "needs_review"   : 1000,
     171     "positive_review": 500,
     172     "needs_info"     : 0,
     173     "needs_work"     : 0,
     174     "unique"         : 40,
     175     "applies"        : 20,
     176     "behind"         : 1
     177    }
     179But you could add
     181 "bonus": {
     182     "vbraun": 10,
     183     "inconito": -5,
     184     "linear programming": 200,
     185     "finance": -200,
     186     "14382": 100,
     187     "15777": 100
     188     }
     191== Looking at patchbot activities ==
     193Remotely, you can have a look at the last tickets tested by patchbots at and the tests without tickets applied can be found at
     195On your machine, the patchbot writes a summary of its activities in $SAGE_ROOT/logs/patchbot/history.txt
     197== using an ipython session ==
     199You can try the patchbot inside a ipython session, as follows.
     201First, in the sage directory, create a branch "patchbot/base" by
     203git checkout develop -b patchbot/base
     207cd sage-patchbot/
     209launch ipython and
     211from sage_patchbot.patchbot import Patchbot
     213opt = {'sage_root': '/home/platon/sage/', 'owner': 'Sophocle'}
     215P = Patchbot(opt)
     217P.test_a_ticket(14974)   # just test one ticket and stop
     219P.test_some_tickets([14974, 19876, 20202])  # test several tickets in the given order
     222The argument dictionary must contain at least:
     224{'sage_root': path to the sage local repository}
     227== Example Configuration and Run-Scripts ==
     229Installation via
     231pip3 install --user git+
     235pip3 install --user sage-patchbot
     238Configuration {{{config.json}}}:
     241    "bonus": {"me": 100},
     242    "parallelism": 2,
     243    "sage_root": "/local/sage-patchbot/sage",
     244    "owner": "This Is Me <>"
     248Script {{{bin/run-patchbot}}}:
     251LANG=C python3 -m sage_patchbot.patchbot --config=/local/sage-patchbot/config.json
     254== Running the patchbot on GitHub Actions ==
     257Go to, use the Fork button to create a fork in your account.
     259Go to the Actions tab,  select "Run patchbot". Push "Run workflow".
     261Instead of the default platform, `ubuntu-focal-standard`, you can select any platform for which we have prebuilt images, see
     263It will run for 6 hours, then exit. You can run multiple workflows simultaneously.
     265See also [[|#33253]].