Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gitpod-io/gitpod-bot

A GitHub App built with Probot that opens issues and pull requests in Gitpod.
https://github.com/gitpod-io/gitpod-bot

github-app gitpod probot probot-app

Last synced: 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/gitpod-io/gitpod-bot
Owner: gitpod-io
License: isc
Created: 2018-09-07T09:15:24.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2019-02-12T20:00:54.000Z (almost 6 years ago)
Last Synced: 2024-09-27T08:02:26.708Z (3 months ago)
Topics: github-app, gitpod, probot, probot-app
Language: TypeScript
Homepage: https://probot.github.io/apps/gitpod/
Size: 45.9 KB
Stars: 19
Watchers: 11
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# gitpod-bot

[Gitpod](http://www.gitpod.io) 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

```sh
# Install dependencies
npm install

# Run typescript
npm run build

# Run the bot
npm start
```

## Usage

1. **[Configure the GitHub App](https://github.com/apps/gitpod-io)**
2. Create `.github/gitpod.yml` based on the following template.
3. 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:

```yml
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](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](CONTRIBUTING.md).

## License