probot /probot
🤖 A framework for building GitHub Apps to automate and improve your workflow
★ 9,637⑂ 1,048👁 120⑃ 1,387● 782▤ 341
+3
Daily
9,637
stars
1,048
forks
120
watchers
1,387
prs
782
issues
341
releases
README
Probot
A framework for building GitHub Apps to automate and improve your workflow
---
If you've ever thought, "wouldn't it be cool if GitHub could…"; I'm going to stop you right there. Most features can actually be added via GitHub Apps, which extend GitHub and can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. Apps are first class actors within GitHub.
How it works
Probot is a framework for building GitHub Apps in Node.js, written in TypeScript. GitHub Apps can listen to webhook events sent by a repository or organization. Probot uses its internal event emitter to perform actions based on those events. A simple Probot App might look like this:
js
export default (app) = {
app.on("issues.opened", async (context) = {
const issueComment = context.issue({
body: "Thanks for opening this issue!",
});
return context.octokit.issues.createComment(issueComment);
});
app.onAny(async (context) = {
context.log.info({ event: context.name, action: context.payload.action });
});
app.onError(async (error) = {
app.log.error(error);
});
};
Building a Probot App
If you've landed in this GitHub repository and are looking to start building your own Probot App, look no further than probot.github.io! The Probot website contains our extensive getting started documentation and will guide you through the set up process.
This repository hosts the code for the npm Probot package which is what all Probot Apps run on. Most folks who land in this repository are likely looking to get started building their own app.
Contributing
Probot is built by people just like you! Most of the interesting things are built _with_ Probot, so consider starting by writing a new app or improving one of the existing ones.
If you're interested in contributing to Probot itself, check out our contributing docs to get started.
Want to discuss with Probot users and contributors? Discuss on GitHub!
Ideas
Have an idea for a cool new GitHub App (built with Probot)? That's great! If you want feedback, help, or just to share it with the world you can do so by creating an issue in the probot/ideas repository!Top issues
#1426Expiration time' claim ('exp') is too far in the future20 comments · 2020-11-28#101Create test infrastructure for probot19 comments · 2017-03-16#1964Nitro example17 comments · 2024-02-02#2269Add "Copy to Clipboard" button for shell commands in documentation14 comments · 2025-11-05#2258octokit request error - JSON web token could not be decoded12 comments · 2025-10-21#2235Probot 14.0.1 - signature validation fails on projects_v2_item.edited when changing a custom number field12 comments · 2025-08-05#1485Throw helpful error if `appId`/`privateKey`/`secret` credentials are not set11 comments · 2021-03-11#1972Testing probot app significantly slower in v1310 comments · 2024-02-09
Discussions
#2292probot is very slow in both tests and prod0 comments · 2026-01-02#2242Settings.yml file0 comments · 2025-09-05#2224Has anything changed in 14.x related to https, `GET /probot`, or `POST /api/github/webhooks`?3 comments · 2025-07-24#2207Best practices for testing - how to avoid `May be caused by lack of authentication` and `an "installation" key is missing`0 comments · 2025-06-25#2206Can't build after upgrading from `14.0.0-full-esm.3` to `14.0.0-beta.20` - is this expected?2 comments · 2025-06-25#2166how to load configuration outside `.github`?1 comments · 2025-05-12#2165Are generic (non-smee) reverse proxies expected to work for webhook delivery?2 comments · 2025-05-07#2135Probot as an Azure Function with multiple routes0 comments · 2025-01-27
Latest release
v14.3.7 v14.3.7 2026-11-0314.3.7 (2026-11-03) Bug Fixes validate CLI and environment numeric options (2389) (7682a9a)