Skip to content

readme: updates for codeball suggester #67

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

Merged
zegl merged 1 commit into from
Aug 18, 2022
Merged

readme: updates for codeball suggester #67

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Codeball is a code review AI which approves Pull Requests that a human would hav

The AI identifies and approves safe contributions, so that you get to focus your energy on the tricky ones.

* Identifies and **approves** safe contributions
* _[beta]_ Generates **code suggestions** from comments ([read more](https://codeball.ai/suggester))

## GitHub Action

The Codeball GitHub Action runs [Codeball](https://codeball.ai/) on all new Pull Requests, and approves the Pull Request ([example](https://github.com/sturdy-dev/codeball-action/pull/7)) if the model classifies it as safe.
Expand All @@ -22,7 +25,10 @@ The Codeball GitHub Action runs [Codeball](https://codeball.ai/) on all new Pull

```yaml
name: Codeball
on: [pull_request]
on:
pull_request: {}
pull_request_review_comment:
types: [created, edited]

jobs:
codeball_job:
Expand All @@ -36,6 +42,7 @@ jobs:
labelPullRequestsWhenApproved: "true"
labelPullRequestsWhenReviewNeeded: "false"
failJobsWhenReviewNeeded: "false"
codeSuggestionsFromComments: "true"
```

2. 🎉 That's it! Codeball will now run on new Pull Requests, and will approve the PR if it's a good one!
Expand Down Expand Up @@ -184,8 +191,9 @@ The Codeball sub-actions are:

* [`sturdy-dev/codeball-action/baller/@v2`](./baller/README.md) – Triggers new Codeball Jobs
* [`sturdy-dev/codeball-action/status/@v2`](./status/README.md) – Waits for the the Codeball result
* [`sturdy-dev/codeball-action/approver/@v2`](./approver/README.md) – Approves PRs
* [`sturdy-dev/codeball-action/approver/@v2`](./approver/README.md) - Approves PRs
* [`sturdy-dev/codeball-action/labeler/@v2`](./labeler/README.md) – Adds labels to PRs
* [`sturdy-dev/codeball-action/suggester/@v2`](./suggester/README.md) – Converts comments to code suggestions

## How Codeball works

Expand Down