Differences between revisions 13 and 18 (spanning 5 versions)
⇤ ← Revision 13 as of 2015-04-23 18:13:27 →
Size: 2190
Editor: chapoton
Comment: more doc
← Revision 18 as of 2015-04-24 10:06:39 → ⇥
Size: 2891
Editor: vdelecroix
Comment:
Deletions are marked like this. Additions are marked like this.
Line 18: Line 18:
It is safer to run the patchbot in an unused sage install.
Line 19: Line 21:

Please consider registering [[buildbot/owners|here]] if you run a patchbot. It is helpful to know whom to contact.
Line 32: Line 36:
You can use a specific configuration file using '''sage -patchbot --config=config_file.json''' By default, the patchbot should run without needing to tune its configuration.

You can use a specific configuration file using '''sage -patchbot --config=fullpath/config_file.json'''
Line 41: Line 47:
To give preference to a component you care about, use

    {"bonus": {"combinatorics": 200}}
Line 44: Line 54:

To run only at night, use

    {"time_of_day": "22-7"}
Line 55: Line 69:

== Looking at patchbot activities ==

Remotely, you can have a look at the last tickets tested by patchbots here:

    http://patchbot.sagemath.org/ticket/0/

On your machine, the patchbot write a summary of its activities in $SAGE_ROOT/logs/patchbot/history.txt		 

┌─┬──────┐
│░│ ⊙  ʘ │        SageMath patchbot
│░│      │
│░│ ──── │
╘═╧══════╛

Running the patchbot

You can let the patchbot choose the tickets it will run on.

It is safer to run the patchbot in an unused sage install.

It will run forever, as long as it finds a ticket to work on. Tickets are only considered if their authors are trusted.

Please consider registering here if you run a patchbot. It is helpful to know whom to contact.

You can run a specific ticket by using sage -patchbot --ticket=N where N is a ticket number such as 12345.

Several other options are available, see sage -patchbot --help

--skip-base will skip the check that the base sage installation is sane.

--plugin-only will only build and run the plugins but not the tests (much quicker but less useful).

--safe-only will only test branches that only change files inside the directory "src/sage" (this is the case by default).

Configuration

By default, the patchbot should run without needing to tune its configuration.

You can use a specific configuration file using sage -patchbot --config=fullpath/config_file.json

For the complete list of configurable entities, see the code of the get_config function in https://github.com/robertwb/sage-patchbot/blob/master/src/patchbot.py. The base patchbot configuration can be found there. All of these settings can be overridden by passing a config file which is treated as a json overlay on these defaults.

For example, to let the tickets of user "niceguy" be given some priority, use:

  • {"bonus": {"niceguy": 200}}

To give preference to a component you care about, use

  • {"bonus": {"combinatorics": 200}}

To avoid the use of ccache, use:

  • {"use_ccache": false}

To run only at night, use

  • {"time_of_day": "22-7"}

A more complex example of config file could be:

  • {"bonus": {"niceguy": 200, "needs_work": -20}, "use_ccache": false, "safe_only": true, "skip_base": true}

Note that the booleans must be written with no capital first letter.

The config will be read again between every run, hence it allows live configuration of the patchbot.

Looking at patchbot activities

Remotely, you can have a look at the last tickets tested by patchbots here:

On your machine, the patchbot write a summary of its activities in $SAGE_ROOT/logs/patchbot/history.txt