tldr-pages / tldr-bot

A simple bot that performs automation tasks on the main tldr repo

tldr-bot

A simple bot that performs automation tasks on the main tldr repo.

Quick start

First of all, set the needed environment variables:

FLASK_APP=/path/to/app/tldr_bot.py
BOT_TOKEN=<token>
REPO_SLUG=tldr-pages/tldr
PORT=<port>

Then run using Flask:

flask run --port=$PORT

Run as a service

See the tldr-bot.service file for an example systemd unit configuration.

Typically, the service is running under uWSGI and fronted by nginx. So you need to set the proper nginx config too.

location / {
    include uwsgi_params;
    uwsgi_pass 127.0.0.1:6129;
}

tldr-bot's Issues

Add reminder when a PR is ready to be merged

When you approve a PR which can't yet be merged, because it was just opened a few hours ago, you prabably mark the notification as done. This either leads to forgetting about the PR and leaving it unmerged for a long time or merging it too early to prevent this problem. This could be solved by a notification from tldr-bot with these requirements:

• The PR has enough approvals and everyone, who requested changes has approved.
• The PR is at least 2 days old and has had no activity for the last 12 hours.
• If there are enough approvals, but not everyone who requested changes approved, set the minimum time to 4 days.

proposal: /commands (set-more-info-link in particular)

I recently wrote a Python script, set-more-info-link.py (tldr-pages/tldr#5654) that takes a page in the format platform/page.md and a link, and adds/updates the link in the page and all translations using a map of the approprate labels.

I was thinking just now that it might be nice to be able to, in a PR, comment something like

@tldr-bot /set-more-info-link common/page.md "https://example.com"

whereupon the bot (@tldr-bot) ran set-more-info-link.py with those arguments, committed the changes to the PR, maybe the message could be like

page: update more information link

If this were approved, I'd be happy to work on it.

Improve readability of error report messages

This was first suggested in tldr-pages/tldr#1380 (comment).

Ideally the error messages would be more human-friendly. Currently they look like this:

The build for this PR has failed with the following message:

pages/linux/calc.md:10: TLDR103 Command example is missing its closing backtick

Please fix the error(s) and push again.

It would be nice to have something the like following, instead:

The build for this PR has failed with the following errors:

On pages/linux/calc.md, line 10:
   `calc -p '{{85 * (36 / 4)}}'
Error: Command example is missing its closing backtick.

Please fix the error(s) and push again.

Get tldr-bot marked as a bot account?

The probot-stale bot we have running has a special bot tag next to it's name. Could we do this for @tldr-bot too?

Use a package management tool to capture dependencies

As @agnivade noted in #6 (comment), a package management tool like Poetry (https://poetry.eustace.io) should be used to capture the dependencies in a Pyproject.toml file.

Add link to this repo in the tldr-bot's user profile

Here: https://github.com/tldr-bot

Change icon/profile pic of the tldr-bot

This was suggested in tldr-pages/tldr#1199 (comment) and tldr-pages/tldr#1380 (comment).

Here's a rough draft to get some ideas rolling:

It is based on the current tldr-pages project icon: