https://github.com/probot/serverless-gcf

An extension for running Probot on Google Cloud Functions
https://github.com/probot/serverless-gcf

gcf google-cloud-functions nodejs probot probot-extension

Last synced: about 1 month ago
JSON representation

An extension for running Probot on Google Cloud Functions

• Host: GitHub
• URL: https://github.com/probot/serverless-gcf
• Owner: probot
• Created: 2018-09-13T19:10:02.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-23T06:58:54.000Z (7 months ago)
• Last Synced: 2024-04-23T11:18:52.139Z (7 months ago)
• Topics: gcf, google-cloud-functions, nodejs, probot, probot-extension
• Language: JavaScript
• Homepage:
• Size: 1.16 MB
• Stars: 14
• Watchers: 3
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Google Cloud Function Handler for Probot

A [Probot](https://github.com/probot/probot) extension to make it easier to run your Probot Apps in Google Cloud Functions.

## Usage

```shell

$ npm install @probot/serverless-gcf

```

```javascript

// handler.js

const { serverless } = require('@probot/serverless-gcf');

const appFn = require('./')

module.exports.probot = serverless(appFn)

```

## Configuration

This package moves the functionality of `probot run` into a handler suitable for usage on Google Cloud Functions. Follow the documentation on [Environment Configuration](https://probot.github.io/docs/configuration/) to setup your app's environment variables. You can add these to `.env`, but for security reasons you may want to use the [gcloud cli](https://cloud.google.com/sdk/gcloud/) or [Serverless Framework](https://github.com/serverless/serverless) to set Environment Variables for the function so you don't have to include any secrets in the deployed package.

## Differences from `probot run`

#### Local Development

Since GCF functions do not start a normal node process, the best way we've found to test this out locally is to use [`serverless-offline`](https://github.com/dherault/serverless-offline). This plugin for the serverless framework emulates AWS Lambda and API Gateway on your local machine, allowing you to continue working from `https://localhost:3000/probot` before deploying your function.

#### Long running tasks

Some Probot Apps that depend on long running processes or intervals will not work with this extension. This is due to the inherent architecture of serverless functions, which are designed to respond to events and stop running as quickly as possible. For longer running apps we recommend using [other deployment options](https://probot.github.io/docs/deployment).

#### Only responds to Webhooks from GitHub

This extension is designed primarily for receiving webhooks from GitHub and responding back as a GitHub App. If you are using [HTTP Routes](https://probot.github.io/docs/http/) in your app to serve additional pages, you should take a look at [`serverless-http`](https://github.com/dougmoscrop/serverless-http), which can be used with Probot's [express server](https://github.com/probot/probot/blob/master/src/server.ts) by wrapping `probot.server`.