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.

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

docs: reorganize reviewkitteh README to favor cloud #142

Merged
merged 2 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 13 additions & 65 deletions reviewkitteh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,77 +11,25 @@ This project automates the process of listening for GitHub pull request events a

## How It Works

1. **Trigger**: The workflow is triggered by a GitHub pull request event (opened or reopened).
2. **Post to Slack**: The program posts an initial message to the Slack channel and continues to update the message as the pull request's state changes.
3. **Random Paging**: Every 15 seconds, the program selects a random person from a Google Sheet and pages them in the Slack channel.
4. **Completion**: The workflow continues until the pull request is closed or merged.
1. Receive GitHub pull request events (opened or reopened)
2. Post updates to Slack with an initial message and dynamic updates as the pull request’s status changes
3. Page team members by selecting a random person from a Google Sheet every 15 seconds and notifying them in Slack
4. Conclude workflow when the pull request is closed or merged

## Installation and Usage
## Cloud Usage (Recommended)

- [Install AutoKitteh](https://docs.autokitteh.com/get_started/install)

### Configure integrations
1. Initialize your connections through the UI
2. Set the `CHANNEL_ID`, `ORG_DOMAIN`, and `SHEET_ID` project variables in the "VARIABLES" tab

> [!IMPORTANT]
> The `autokitteh.yaml` file includes environment variables for the GitHub, Slack, and Google Sheets connections that need to be configured. When setting the `CHANNEL` variable, be sure to use the channel ID, not the channel name.

Ensure you have set up the required integrations:

- [GitHub](https://docs.autokitteh.com/integrations/github)
- [Google Sheets](https://docs.autokitteh.com/integrations/google)
- [Slack](https://docs.autokitteh.com/integrations/slack)

### Clone the Repository

```shell
git clone https://github.com/autokitteh/kittehub.git
cd kittehub/reviewkitteh
```

Alternatively, you can copy the individual files in this directory.

### Run the AutoKitteh Server

Simply run this command:

```shell
ak up --mode dev
```

### Apply Manifest and Deploy Project
> Must be a Slack channel ID, not a Slack channel name.

1. Navigate to the `reviewkitteh` directory:
3. Deploy the project

```shell
cd reviewkitteh
```
## Trigger Workflow

2. Apply manifest and deploy the project by running the following command:

```shell
ak deploy --manifest autokitteh.yaml --file program.py
```

The output of this command will be important for initializing connections in the following step if you're using the CLI.

For example, for each configured connection, you will see a line that looks similar to the one below:

```shell
[exec] create_connection "reviewkitteh/slack_connection": con_01j36p9gj6e2nt87p9vap6rbmz created
```

`con_01j36p9gj6e2nt87p9vap6rbmz` is the connection ID.

### Initialize Connections

Using the connection IDs from the previous step, run these commands:

```shell
ak connection init my_github <connection ID>
ak connection init my_slack <connection ID>
ak connection init my_googlesheets <connection ID>
```
Once deployed, the workflow is triggered by a GitHub pull request event and continues to run, updating Slack until the pull request is closed or merged.

### Trigger the Workflow
## Self-Hosted Deployment

Once deployed, the workflow is triggered by a GitHub pull request event and continues to run, updating Slack until the pull request is closed or merged.
Follow these [detailed instructions](https://docs.autokitteh.com/get_started/deployment) to deploy the project on a self-hosted server.
2 changes: 1 addition & 1 deletion room_reservation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ The list of meeting rooms is stored in a Google Sheet with the following format:

## Self-Hosted Deployment

Follow the [detailed instructions](https://docs.autokitteh.com/get_started/deployment) to deploy the project on a self-hosted server.
Follow these [detailed instructions](https://docs.autokitteh.com/get_started/deployment) to deploy the project on a self-hosted server.
Loading