gitpod-io / gitpod-bot Goto Github PK

View Code? Open in Web Editor NEW

19.0 12.0 5.0 47 KB

A GitHub App built with Probot that opens issues and pull requests in Gitpod.

Home Page: https://probot.github.io/apps/gitpod/

License: ISC License

TypeScript 100.00%

gitpod probot probot-app github-app

gitpod-bot's Introduction

gitpod-bot

Gitpod is a one-click online IDE for GitHub. It can be started on any GitHub URL by prefixing it with gitpod.io#. Gitpod Bot generates such links for issues and pull requests and post them as comments.

Setup

# Install dependencies
npm install

# Run typescript
npm run build

# Run the bot
npm start

Usage

Configure the GitHub App
Create .github/gitpod.yml based on the following template.
It will start scanning for issues and/or pull requests within an hour.

A .github/gitpod.yml file is required to enable the plugin. The file can be empty, or it can override any of these default settings:

pulls:
# Enable for pull requests
  perform: true
# Customize a comment to post on a pull request. Comment out to use the default
#  comment:

issues:
# enable for issues
  perform: true
# issues with these labels will be considered. Set to `[]` to disable for issues
  labels:
    - help wanted
    - good first issue
# Customize a comment to post on an issue. Comment out to use the default
#  comment:

Deployment

See doc/Deploying.md if you would like to run your own instance of this plugin.

Contributing

If you have suggestions for how gitpod-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

gitpod-bot's People

Contributors

Stargazers

Watchers

Forkers

bonomali alangreene orbulon alexrogalskiy nqdev-fork

gitpod-bot's Issues

Support exempt labels for issues

For example, an issue does not need a comment if it is labeled with windows.

Enable Gitpod links in pull requests by default?

@akosyakov Thanks for releasing this bot!

It looks super useful, but I’m a bit surprised that it doesn’t do anything by default. Adding Gitpod links to all Pull Requests is such a killer feature that I’d expect it to do that by default once installed on a repository (like any other GitHub App, e.g. Reviewable, Travis, CircleCI, etc. they all perform default actions once they're installed). Instead, I just installed an App that doesn’t do anything, and I need to add yet another config file to my repository to fix that…

Bug steps:

install gitpod-bot for your repository
open a new pull request on this repository

Expected behavior:

gitpod-bot should add a Gitpod link to the new pull request
you can optionally configure any non-standard behavior by adding a config file to your repository

Actual behavior:

installing gitpod-bot doesn't do anything by default (no link appears in new pull requests)
you must perform an extra step: add yet another config file to your repository, in order to make the bot do useful things

(My suggestion makes that config file optional by default, which is great for lazy people like myself.)

Notify about GithubProject activities at Slack channels

For our engineering teams we have the following channels:

IDE:
- #team-ide-inbox
WEBAPP:
- #team-webapp-project,
SELF-HOSTED(prev):
- #team-delivery-operations-experience
WORKSPACE
- #team-workspace-board, #team-workspace

Whenever something is changed in our Github-Projects, and the change matches with our requirements, an update is posted on those channels ☝.

Currently we use a zap[1] on zapier.com to receive incoming webhook[2] payload, run some js code to fetch additional data[3] and finally post on slack if the requirements are met. However, using zapier for this does not look scalable in the long term[4] due to costs. We need your help to implement this via some of the Github bots that you operate. Maybe via https://github.com/gitpod-io/gitbot (I assume this is roboquat?).

Thank you 🙏

Originally this was bought up in Slack.

Q: How do I access the zap?
A: Use the shared 1password credentials to login and then open the zap link I shared ☝️