Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

s/repokitteh.sky/repokitteh.star/ et al #4945

Merged
merged 2 commits into from Nov 2, 2018
Merged

s/repokitteh.sky/repokitteh.star/ et al #4945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1ee0a6
s/repokitteh.sky/repokitteh.star/ et al
itayd Nov 2, 2018
87b6418
Update repokitteh.md
itayd Nov 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions repokitteh.sky
View file
Open in desktop

This file was deleted.

2 changes: 2 additions & 0 deletions repokitteh.star
View file
Open in desktop
@@ -0,0 +1,2 @@
use("github.com/softkitteh/repokitteh-modules/assign.star")
use("github.com/softkitteh/repokitteh-modules/review.star")
12 changes: 6 additions & 6 deletions source/docs/repokitteh.md
View file
Open in desktop
Expand Up @@ -5,20 +5,20 @@
<img src="https://repokitteh.io/logo.svg" height="100" align="right">

[RepoKitteh](https://repokitteh.io) is a [GitHub application](https://developer.github.com/apps/) that provides an easy way to create, integrate and maintain GitHub bots. It is deployed in GCP and supplied to Envoy under a contract with the CNCF.
The application is installed on specific GitHub repositories and interacts with these by receiving webhooks and making GitHub API calls. A root `repokitteh.sky` script tells the application what to do based on the webhook received.
The application is installed on specific GitHub repositories and interacts with these by receiving webhooks and making GitHub API calls. A root `repokitteh.star` script tells the application what to do based on the webhook received.

## Integration with Envoy
The file [repokitteh.sky](https://github.com/envoyproxy/envoy/blob/master/repokitteh.sky), which resides in the root of the Envoy repository tells RepoKitteh what functionality to use. The file is written in the [~~Skylark~~ Starlark language](https://github.com/bazelbuild/starlark/), which is a Python dialect with well defined threading and hermeticity guarantees.
The file [repokitteh.star](https://github.com/envoyproxy/envoy/blob/master/repokitteh.star), which resides in the root of the Envoy repository tells RepoKitteh what functionality to use. The file is written in the [Starlark language](https://github.com/bazelbuild/starlark/), which is a Python dialect with well defined threading and hermeticity guarantees.

For example, the statement
```
use("github.com/softkitteh/repokitteh-modules/assign.sky")
use("github.com/softkitteh/repokitteh-modules/assign.star")
```
tells RepoKitteh to use the [assign.sky](https://github.com/softkitteh/repokitteh-modules/blob/master/assign.sky) module.
tells RepoKitteh to use the [assign.star](https://github.com/softkitteh/repokitteh-modules/blob/master/assign.star) module.
Similar modules can be integrated in the future into Envoy in the same way.

## Current Functionality
### [Assign](https://github.com/softkitteh/repokitteh-modules/blob/master/assign.sky)
### [Assign](https://github.com/softkitteh/repokitteh-modules/blob/master/assign.star)
Set assignees to issues or pull requests.

Examples:
Expand All @@ -36,7 +36,7 @@ Only organization members can assign or unassign other users, who must be organi

[Demo PR](https://github.com/envoyproxy/envoybot/pull/6)

### [Review](https://github.com/softkitteh/repokitteh-modules/blob/master/review.sky)
### [Review](https://github.com/softkitteh/repokitteh-modules/blob/master/review.star)
Requests a a user to recview a pull request.

Examples:
Expand Down