{"id":20564338,"url":"https://github.com/tarantool/docbot","last_synced_at":"2026-03-06T06:31:00.416Z","repository":{"id":33910278,"uuid":"128082297","full_name":"tarantool/docbot","owner":"tarantool","description":"Bot to automate some GitHub things","archived":false,"fork":false,"pushed_at":"2025-01-13T09:24:51.000Z","size":45,"stargazers_count":4,"open_issues_count":9,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-21T15:45:05.728Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tarantool.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-04-04T15:26:48.000Z","updated_at":"2025-01-13T09:24:55.000Z","dependencies_parsed_at":"2023-11-09T12:39:45.008Z","dependency_job_id":"71a866c4-5fec-4e02-89a6-8d6bea129c83","html_url":"https://github.com/tarantool/docbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tarantool/docbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarantool%2Fdocbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarantool%2Fdocbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarantool%2Fdocbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarantool%2Fdocbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tarantool","download_url":"https://codeload.github.com/tarantool/docbot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tarantool%2Fdocbot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30164590,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T04:43:31.446Z","status":"ssl_error","status_checked_at":"2026-03-06T04:40:30.133Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T04:25:50.330Z","updated_at":"2026-03-06T06:31:00.372Z","avatar_url":"https://github.com/tarantool.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocBot - Tarantool Documentation pipeline bot\n\n[![Build Status](https://travis-ci.org/tarantool/docbot.svg?branch=master)](https://travis-ci.org/tarantool/docbot)\n\nTarantoolBot automates a process of creating a documentation request after\nexternal behaviour is changed. Documentation bot has its own account on mail.ru\nand on github.com. Its name is TarantoolBot. It uses GitHub webhooks to track\nall new comments on issues and commits. In a comment or a commit message a one\ncan ask the bot to create a new issue on tarantool/doc, when the original issue\nwill be closed or the commit will be pushed, using the special template. The one\nmust mention the bot, write a title and description:\n```\n@TarantoolBot document\nTitle: one-line title\nDescription that can be multiline,\ncontain markup and links.\n```\nWhen the bot sees its mentioning, it checks the request syntax and writes result\nof request parsing into its web [journal](https://tarantool-docbot.herokuapp.com).\n\nIf the request had been done via issue comments, then the bot responds with\neither error description or with `@\u003cCommentAuthor\u003e: Accept` right into the issue\ncomments. When the issue is closed, the bot finds this comment, extracts the\ntitle and description, and creates a new issue on tarantool/doc with notifying\nthe comment author and the original issue/commit.\n\nWhen the request is in the commit message, a one should write the request at the\nend of the message. Even after `Closes/Fixes etc` GitHub hits. All below the\n`@TarantoolBot document` is treated as a request.\n\nThanks to the bot, now no one must care about creating a doc issue after push\ninto trunk, changing some external behaviour.\n\n## Deployment\n\nBuild Docker container with:\n\n```sh\ndocker build -t docbot .\n```\n\nThen run it like this:\n\n```sh\ndocker run \\\n    -d -p5000:5000 \\\n    -e GITHUB_TOKEN=\u003ctoken\u003e \\\n    -e GITHUB_SIGN_KEY=\u003csign_key\u003e \\\n    -e PROMETHEUS_TOKEN=\u003ctoken\u003e \\\n    --name docbot docbot\n```\n\nTo check that it works try to get `localhost:5000` - it will print the\n**TarantoolBot Journal** message, if all is ok. After this set a GitHub hook in\nthe repository, that you want the bot tracks. The hook must send notifications\nabout new comments in all issues, about closed issues, log all events onto its\nwebpage.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftarantool%2Fdocbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftarantool%2Fdocbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftarantool%2Fdocbot/lists"}