Skip to content

Commit

Permalink
Add documentation about local debug functionality.
Browse files Browse the repository at this point in the history
  • Loading branch information
ytausch committed Feb 2, 2024
1 parent 55bf4c1 commit a715667
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,27 @@ in the `autotick-bot` subdirectory.
If you want to stop the worker, rename the file to `please.stop` and it will not restart
itself on the next round.


## Debugging Locally
You can use the CLI of the bot to debug it locally. To do so, install the bot with the following command:
```bash
pip install -e .
```

Then you can use the CLI like this:
```bash
conda-forge-tick --help
```

For debugging, use the `--debug` flag. This enables debug logging and disables multiprocessing.

Note that the bot expects the [conda-forge dependency graph](https://github.com/regro/cf-graph-countyfair) to be
present in the current working directory by default. Use `--online` to download missing files on demand from GitHub.

The local debugging functionality is still work in progress and might not work for all commands.
Currently, the following commands are supported and tested:
- `update-upstream-versions`

## What has the bot done recently?

Check out its [PRs](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+author%3Aregro-cf-autotick-bot+archived%3Afalse+), its currently [running jobs](https://github.com/regro/cf-scripts/actions?query=is%3Ain_progress++), and the [status page](https://conda-forge.org/status/#current_migrations)!

0 comments on commit a715667

Please sign in to comment.