An unofficial GitHub Probot that helps reveiwing on Read the Docs
Clone or download
dependabot-bot and KengoTODA build(deps): bump typescript from 3.1.2 to 3.1.3
Bumps [typescript](https://github.com/Microsoft/TypeScript) from 3.1.2 to 3.1.3.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](Microsoft/TypeScript@v3.1.2...v3.1.3)

Signed-off-by: dependabot[bot] <support@dependabot.com>
Latest commit 1c3d335 Oct 13, 2018

README.md

Get URL of staging document, when you review changes.

Build Status Commitizen friendly semantic-release

Work with Read the Docs, then you'll find that PR for documentation needs additional steps like:

  • running RTD build for your branch manually, to use its result as staging site like this, or
  • sharing screenshot to share the updated document like this.

This bot automates the first approach; activate RTD build automatically when you made PR that updates docs/ directory.

screenshot

Installation

To install rtd-bot to your GitHub repository, follow these interactions:

  1. Make sure that your RTD project has been connected with GitHub repository, or integrated via GitHub webhook.
  2. Invite rtd-bot user to your RTD project as maintainer.
  3. Add rtd.project config to .github/config.yml file in your repo.
  4. Enable rtd-bot in your repo from the rtd-bot page at GitHub.

Here is a sample .github/config.yml:

rtd:
  project: your-read-the-docs-project

Configuration for the project with translations

If you use translations feature, make sure you've configured all your RTD projects including translations.

In .github/config.yml file, set the project slug of the root RTD project.

Deployment

In Read the Docs, inviting maintainer means you give admin access to target account. So if you do not want to invite rtd-bot as maintainer, you can host this Probot app by own.

To host this bot by own, you need to set following environment variables:

  1. RTD_USERNAME that is same with user name of Read the Docs
  2. RTD_PASSWORD that is same with password of Read the Docs
  3. WEBHOOK_SECRET and APP_ID that is described at Probot document.
  4. One of PRIVATE_KEY_PATH or PRIVATE_KEY that is described at Probot document.

To run this bot on Heroku, you need to add a buildpack. See puppeteer document for detail.

License

Copyright 2018 Kengo TODA

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.