explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2024-09-22 11:59:14 +03:00
Code Issues Packages Projects Releases Wiki Activity
29afbdb91e
spaCy/extra/DEVELOPER_DOCS/ExplosionBot.md
Ryn Daniels 29afbdb91e
add readme for explosion-bot (#10677)
2022-04-20 09:52:34 +02:00

2.2 KiB
Raw Blame History

Explosion-bot

Explosion-bot is a robot that can be invoked to help with running particular test commands.

Permissions

Only maintainers have permissions to summon explosion-bot. Each of the open source repos that use explosion-bot has its own team(s) of maintainers, and only github users who are members of those teams can successfully run bot commands.

Running robot commands

To summon the robot, write a github comment on the issue/PR you wish to test. The comment must be in the following format:

@explosion-bot please test_gpu

Some things to note:

  • The @explosion-bot please must be the beginning of the command - you cannot add anything in front of this or else the robot won't know how to parse it. Adding anything at the end aside from the test name will also confuse the robot, so keep it simple!
  • The command name (such as test_gpu) must be one of the tests that the bot knows how to run. The available commands are documented in the bot's workflow config and must match exactly one of the commands listed there.
  • The robot can't do multiple things at once, so if you want it to run multiple tests, you'll have to summon it with one comment per test.
  • For the test_gpu command, you can specify an optional thinc branch (from the spaCy repo) or a spaCy branch (from the thinc repo) with either the --thinc-branch or --spacy-branch flags. By default, the bot will pull in the PR branch from the repo where the command was issued, and the main branch of the other repository. However, if you need to run against another branch, you can say (for example):
@explosion-bot please test_gpu --thinc-branch develop

Troubleshooting

If the robot isn't responding to commands as expected, you can check its logs in the Github Action.

For each command sent to the bot, there should be a run of the explosion-bot workflow. In the Install and run explosion-bot step, towards the ends of the logs you should see info about the configuration that the bot was run with, as well as any errors that the bot encountered.