staxly

a GitHub App built with probot that automates common GitHub & Slack tasks. It is used by OpenStax

Features

These are features coded into the bot:

Slack Channel link-back

When someone mentions a channel in a message, that channel gets a link back to the original message. This is useful for notifying multiple groups, or casually asking for help.

Other features

• #74 verify that PR descriptions contain a link to their issue
• #73 automatically update PRs when their base branch has new commits (that will naturally trigger the checks to run again)
• #8 Reminder to add a Pull Request Reviewer

Plugins

These are 3rd-party plugins that are included in this bot:

• based on changelog: Automatically ensure that the CHANGELOG is updated for every Pull Request (configured in the repos /.github/config.yml)
• settings: Pull Requests for GitHub repository settings
• autolabeler: Automatically label Issues and Pull Requests based on logic in the .github/config.yml file
• probot-app-todos: Help create Issues when code contains a “TO DO” (no spaces)
• release-notifier: When a tag is created add a comment on the Pull Request denoting which release it was included in

Contributing

To make development approachable to many types of contributors, there are several ways to get your awesome code up and running. The Beginner option is a great way to get started with minimal setup. Knowledge of Git is not even needed!

1. Beginner: Start a Pull Request and push up changes until it works
   • As soon as you create the Pull Request, (staxly-dev will be auto-deployed for you
   • This bot listens to changes in a couple of test repositories or you can install it on one of your repositories for testing
   • As you continue pushing changes, the bot will automatically be re-deployed and your Pull Request will be updated
   • See #26 for a screncap of the whole process
2. Intermediate: Ask a maintainer for dev keys to staxly-dev
3. Advanced: Follow probot’s instructions for creating a new GitHub App

Additional details can be found in CONTRIBUTING.md.

What do you think of this bot?

A bot would… (click one of the bars to vote and check out the Issues to see proposals)

If it is doing something wrong or you would like it to do something else, check out the Issues.

This site is open source. Improve this page.