10 KiB

Raw Blame History

next
docs/serverless-deployment.md

Deployment

Every app can either be deployed stand-alone, or combined with other apps in one deployment.

Heads up! Note that most apps in the @probot organization have an official hosted app that you can use for your open source project. Use the hosted instance if you don't want to deploy your own.

Contents:

Create the GitHub App
Deploy the app
1. Glitch
2. Heroku
3. Now
4. GitHub Actions
Share the app
Combining apps
Error tracking
Serverless Deployments

Create the GitHub App

Every deployment will need an App.

Create a new GitHub App with:
- Homepage URL: the URL to the GitHub repository for your app
- Webhook URL: Use https://example.com/ for now, we'll come back in a minute to update this with the URL of your deployed app.
- Webhook Secret: Generate a unique secret with openssl rand -base64 32 and save it because you'll need it in a minute to configure your deployed app.
Download the private key from the app.
Make sure that you click the green Install button on the top left of the app page. This gives you an option of installing the app on all or a subset of your repositories.

Deploy the app

To deploy an app to any cloud provider, you will need 3 environment variables:

APP_ID: the ID of the app, which you can get from the app settings page.
WEBHOOK_SECRET: the Webhook Secret that you generated when you created the app.

And one of:

PRIVATE_KEY: the contents of the private key you downloaded after creating the app, OR...
PRIVATE_KEY_PATH: the path to a private key file.

PRIVATE_KEY takes precedence over PRIVATE_KEY_PATH.

Glitch

Glitch lets you host node applications for free and edit them directly in your browser. It’s great for experimentation and entirely sufficient for simple apps.

Create a new app on Glitch.
Click on your app name on the top-right, press on advanced options and then on Import from GitHub (You will need to login with your GitHub account to enable that option). Enter the full repository name you want to import, e.g. for the welcome app it would be behaviorbot/new-issue-welcome. The new-issue-welcome app is a great template to get started with your own app, too!
Next open the .env file and replace its content with
```
APP_ID=<your app id>
WEBHOOK_SECRET=<your app secret>
PRIVATE_KEY_PATH=.data/private-key.pem
NODE_ENV=production
```
Replace the two <...> placeholders with the values from your app. The .env file cannot be accessed or seen by others.
Press the New File button and enter .data/private-key.pem. Paste the content of your GitHub App’s private-key.pem in there and save it. Files in the .data folder cannot be seen or accessed by others, so your private key is safe.
That’s it, your app should have already started 👍 Press on the Show button on top and paste the URL as the value of Webhook URL. Ensure that you remove /probot from the end of the Webhook URL that was just pasted.

Enjoy!

Bonus: You can deploy your app using glitch-deploy directly from your terminal or as continuous deployment.

Heroku

Probot runs like any other Node app on Heroku. After creating the GitHub App:

Make sure you have the Heroku CLI client installed.
Clone the app that you want to deploy. e.g. git clone https://github.com/probot/stale

Create the Heroku app with the heroku create command:

 $ heroku create
 Creating arcane-lowlands-8408... done, stack is cedar
 http://arcane-lowlands-8408.herokuapp.com/ | git@heroku.com:arcane-lowlands-8408.git
 Git remote heroku added

Go back to your app settings page and update the Webhook URL to the URL of your deployment, e.g. http://arcane-lowlands-8408.herokuapp.com/.
Configure the Heroku app, replacing the APP_ID and WEBHOOK_SECRET with the values for those variables, and setting the path for the PRIVATE_KEY:
```
 $ heroku config:set APP_ID=aaa \
     WEBHOOK_SECRET=bbb \
     PRIVATE_KEY="$(cat ~/Downloads/*.private-key.pem)"
```

Deploy the app to heroku with git push:

 $ git push heroku master
 ...
 -----> Node.js app detected
 ...
 -----> Launching... done
       http://arcane-lowlands-8408.herokuapp.com deployed to Heroku

Your app should be up and running! To verify that your app is receiving webhook data, you can tail your app's logs:
```
 $ heroku config:set LOG_LEVEL=trace
 $ heroku logs --tail
```

Now

Zeit Now is a great service for running Probot apps. After creating the GitHub App:

Install the now CLI with npm i -g now
Clone the app that you want to deploy. e.g. git clone https://github.com/probot/stale
Run now to deploy, replacing the APP_ID and WEBHOOK_SECRET with the values for those variables, and setting the PRIVATE_KEY:
```
 $ now -e APP_ID=aaa \
     -e WEBHOOK_SECRET=bbb \
     -e NODE_ENV=production \
     -e PRIVATE_KEY="$(cat ~/Downloads/*.private-key.pem | base64)"
```
NOTE: Add -e LOG_LEVEL=trace to get verbose logging, or add -e LOG_LEVEL=info instead to show less details.
Once the deploy is started, go back to your app settings page and update the Webhook URL to the URL of your deployment (which now has kindly copied to your clipboard).
Your app should be up and running! For long term use, create an alias for your app. After making an alias, you can swap to new deploy URLs with no downtime.
```
 $ now alias set https://your-generated-url.now.sh https://a-fancier-url.now.sh
```
You can also keep your app running forever, with instant response to webhooks with:
```
 $ now scale https://a-fancier-url.now.sh 1
```

GitHub Actions

Heads Up! GitHub Actions is still in limited beta.

GitHub Actions allows you to trigger workflows based on GitHub events, which makes it a great fit for running Probot Apps. To run your app on GitHub Actions:

Add a Dockerfile to your app:

FROM node:10

ENV PATH=$PATH:/app/node_modules/.bin
WORKDIR /app
COPY . .
RUN npm install --production

ENTRYPOINT ["probot", "receive"]
CMD ["/app/index.js"]

In the repository that you want to run the app, create a .github/main.workflow file that defines the action and listens for any events that your app depends on. For example, here is the workflow for @jasonetco's TODO:

workflow "Check for TODOs in Pull Requests" {
  on = "pull_request"
  resolves = "TODO"
}

workflow "Check for TODOs on Push" {
  on = "push"
  resolves = "TODO"
}

action "TODO" {
  uses = "jasonetco/todo@master"
  secrets = ["GITHUB_TOKEN"]
}

uses inside an action must take the form owner/repo@ref, where ref can be a branch: jasonetco/todo@master, a tag: jasonetco/todo@v1.0.0, or a commit sha: jasonetco/todo@f61798f9722c6af9dd12781ea3512306ea451bce.

There are a few caveats when running Probot Apps on GitHub Actions:

The GitHub API token available to actions has a fixed set of permissions, and only has access to the repository that triggered the action. app.auth() will always return a GitHub client authenticated for the current repository.
probot/scheduler and other extensions that require long-running processes are not currently supported.
Your app cannot expose HTTP routes

The Probot website includes a list of featured apps. Consider adding your app to the website so others can discover and use it.

Combining apps

To deploy multiple apps in one instance, create a new app that has the existing apps listed as dependencies in package.json:

{
  "name": "my-probot-app",
  "private": true,
  "dependencies": {
    "probot-autoresponder": "probot/autoresponder",
    "probot-settings": "probot/settings"
  },
  "scripts": {
    "start": "probot run"
 },
 "probot": {
   "apps": [
     "probot-autoresponder",
     "probot-settings"
   ]
 }
}

Error tracking

Probot comes bundled with a client for the Sentry exception tracking platform. To enable Sentry:

Install Sentry from Marketplace (with 10k events/month free) or host your own instance (Students can get extra Sentry credit)
Follow the setup instructions to find your DSN.
Set the SENTRY_DSN environment variable with the DSN you retrieved.

Serverless

Serverless abstracts away the most menial parts of building an application, leaving developers to write code and not actively manage scaling for their applications. The Serverless Deployment section will show you how to deploy you application using functions instead of servers.

10 KiB Raw Blame History Unescape Escape