nit

package module
v0.0.0-...-91a460c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 9, 2024 License: MIT Imports: 8 Imported by: 0

README

Nit - AI generate code reviews

Go Reference

Nit is a web server that responds to Github webhook events. It will generate and post code reviews on pull requests and respond to comments in the thread. This is a tool to help developers improve the quality of their pull request before requesting review from another dev. Common nit-picky feedback is the goal, but it can suggest improvements, alternative solutions and larger refactors. The feedback can be noisy (hoping to cut down on that) but some good outcomes have emerged from this additional layer of oversight. This tool is used today at Leadpages.

How to Use

You will need to deploy this project to a server - which ever way you like to do that - you do you. The entry point is cmd/server/main.go.

Create webhook

Add a webhook to the repository you would like generated reviews.

  1. Visit Settings > Webhooks > Add webhook
  2. You will need to authenticate with Github in order to perform this action
  3. Configure the webhook
    • Payload URL = <yourhostname>/webhooks/github
    • Content type = application/json
    • Secret = (optional/recommended) generate a webhook secret and write it down
    • Webhook events = select individual events - Pull requests and Pull request review comments
  4. Click Add webhook when ready
Generate access token

Create a Github fine-grained access token for your account. I recommend creating the token at the Organization level if possible. Review will be posted on behalf of the account that the token belongs too.

  1. In your accounts personal settings > Developer settings > Personal access tokens > Fine-grained access tokens > Generate new token
  2. Generate a token with access to the repository you created the webhook in. The specific permissions you need are:
    • Read and write access to pull requests
    • Read access to code and metadata
  3. Click Generate token when ready
Set environment variables

Customize your server environment variables. You can edit the config.yaml file directly or set the environment variables yourself - which ever way you like to do that - you do you.

To create environment variables, the config setting ...

app:
  webhookSecret: 1234

...can be overridden by setting an environment variable with the name NIT_APP_WEBHOOKSECRET.

Configuration

The behaviour of the app can be configured from the config.yaml file or with these environment variables.

NIT_CONFIG_OPTIN

  • Whether or not pull request reviews need to be opted into.
  • If true, the string ai-review:please must be in the pull request description for a review to be generated.
  • If false, the string ai-review:ignore will cause the pull request to be ignored.
  • The default is true.

NIT_CONFIG_NAME

  • The name of the account the fine-grained access token belongs too. If I created the token, the name would be evanmcneely.
  • The default is nit.

Development

Add a new service provider

Adding new AI service providers is as simple implementing the AIProvider interface. Every implementation would ideally handle a completionRequest to use a "Good" or "Cheap" model. Good being whatever the best model in the line up is in terms of "reasoning" ability, and Cheap being the cost effective one. If the response format is "JSON", the completionResponse must be valid JSON or nothing will work.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewAnthropic 

func NewAnthropic(key string) *anthropicProvider

func NewOpenAI 

func NewOpenAI(key string) *openAIProvider

func ShouldRespondToComment 

func ShouldRespondToComment(e *github.PullRequestReviewCommentEvent, client *github.Client, config *Config) (bool, string)

func ShouldReviewPullRequest 

func ShouldReviewPullRequest(e *github.PullRequestEvent, c *Config) (bool, string)

Types

type AI 

type AI struct {
	Cheap AIProvider
	Good  AIProvider
}

func NewAI 

func NewAI(good AIProvider, cheap AIProvider) *AI

func (*AI) GenerateCommentReply 

func (ai *AI) GenerateCommentReply(comment, hunk string, allComments []*github.PullRequestComment, name string) (*CompletionResponse, error)

Create a reply for thread of GitHub comments on a particular pull request hunk. The output of the string "noreply" indicates that no reply should be made (ie. the conversation has reached an end).

func (*AI) GeneratePullRequestReview 

func (ai *AI) GeneratePullRequestReview(number int, title, description, prDiff string) (*github.PullRequestReviewRequest, int, error)

Creates a valid pull request review payload to be POSTed to the GitHub Rest API at /repos/{owner}/{repo}/pulls/{pull_number}/reviews.

see https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#create-a-review-for-a-pull-request

func (*AI) NewCompletion 

func (ai *AI) NewCompletion() *completion

type AIProvider 

type AIProvider interface {
	CreateCompletetion(req *completionRequest) (*CompletionResponse, error)
}

The interface that an AI provider (such as OpenAI or Anthropic) must implement to be used in this package. Fulfilling this interface makes it easier to experiment with different AI providers.

type CommentResponse 

type CommentResponse struct {
	Tokens int
	Id     int64
}

func RespondToComment 

func RespondToComment(event *github.PullRequestReviewCommentEvent, config *Config, ai *AI, gh *github.Client) (*CommentResponse, error)

type CompletionResponse 

type CompletionResponse struct {
	Completion string
	Tokens     int
}

type Config 

type Config struct {
	OptIn   bool
	AppName string
}

type ReviewResponse 

type ReviewResponse struct {
	Tokens int
	Id     int64
}

func ReviewPullRequest 

func ReviewPullRequest(event *github.PullRequestEvent, ai *AI, gh *github.Client) (*ReviewResponse, error)

Source Files

View all Source files

Directories

Path Synopsis
cmd
server command
internal
config

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.