DEV Community: Tatsuya Sato

Labeling by GPT

Tatsuya Sato — Sun, 21 May 2023 16:17:24 +0000

What I built

I developed a GitHub Action that chooses suitable labels for an opened/edited issue and puts the labels to the issue automatically without predefined rules.

Category Submission:

Maintainer Must-Haves

App Link

Labeling by GPT · Actions · GitHub Marketplace

Screenshots

You can see this issue and try it by opening new issue!

Description

When an issue is opened/edited, this action reads its title and description, choose suitable labels in the repository and add those labels to the issue.

You don't need to define rules which issue should should have which labels in advance.

Link to Source Code

satoryu / labeling-by-gpt

This action puts labels to an issues in the repository autocratically without pre-defined rule.

Labeling by GPT

When creating new issue, this action puts labels to an issues in the repository autocratically without pre-defined rule. This is powered by OpenAI completion API to choose suitable labels.

Please note that this action supports only issues trigger and the two types: opened and edited.

Inputs

`openai-api-key`

Required Your OpenAI API Key.

`github-token`

Optional. GitHub API token to access GitHub API. The default value is secrets.GITHUB_TOKEN, an API token provided for an action. Be sure of that this token has a permission to put labels to an issue. This document would help you.

Example

on:
  issues:
    types: [opened, edited]

jobs:
  test:
    name: test
    runs-on: ubuntu-latest

    steps:
      - uses: satoryu/labeling-by-gpt@main
        with:
          openai-api-key: ${{ secrets.OPENAI_API_KEY }}

View on GitHub

Permissive License

MIT License

Background

In maintaining OSS projects, triage is an important activity. GitHub provides 'labeling issues' feature to help maintainers triage their repositories' issues. But triage is boring! As new issue is opened, maintainers have to read its title and description then choose suitable labels and add the labels to it. As issues in a repository increases, the workload of triage increases too. If there were few maintainers of the repo, triage would be impossible.
GitHub Action has the possibility to reduce this workload. But maintainers would define rules　in advance in which condition and labels the action should choose and add to an issue.

On the other hand, NLP is getting popular by ChatGPT, OpenAI APIs. OpenAI completion API processes several tasks to a given text 'prompt'. I came up with the idea that this API would help maintainers triage their issues.

This is my motivation to develop this GitHub action.

How I built it

First, I had to confirm that OpenAI completion API works as I want: choose suitable labels from available labels in a repository.
In order to do it, I used ChatGPT:

Next, I implemented and test it on its repository.
This is quite simple and easy: define a YAML file under .github/workflows.

on:
  issues:
    types: [opened, edited]

jobs:
  test:
    name: test
    runs-on: ubuntu-latest

    steps:
      - uses: satoryu/labeling-by-gpt@main
        with:
          openai-api-key: ${{ secrets.OPENAI_API_KEY }}

Specifying the main branch like satoryu/labeling-by-gpt@main not version (e.g. v0.0.1) always refers to the latest version of this action. This configuration is good for testing on GitHub.

Additional Resources/Info

About custom actions - GitHub Docs
- This doc gave me the basics how to implement an action in JavaScript.
hwchase17/langchain: ⚡ Building applications with LLMs through composability ⚡
- I've read some prompts in this code. The prompts give me some hints to implement a prompt of my github action.

Undine v0.2.0 released

Tatsuya Sato — Wed, 29 Apr 2020 10:52:06 +0000

When developing, sometimes you might run your code to check how it works.
At that time, you might see an exception you didn't expect before.
What's next?
If I were you, I would google with the error message to find blog posts and documents dealing with the exception.
You too?

Today I released new version of Undine 🎉 : Undine adds a termination process at exit to open google search with error message of exception unrescued in your Ruby code.

satoryu / undine

Open your browser for searching the message of an unrescued exception.

Undine

Undine is a gem to help your development experience: When an exception unrescued in your code is raised, opens google search with the errror message in your browser.

Installation

Add this line to your application's Gemfile:

gem 'undine', group: :development

And then execute:

    bundle install

Or install it yourself as:

    gem install undine

Usage

Just require 'undine' and Undine.load. That's it.

Example

require 'undine'

Undine.load

def something_function
  'hoge'.foo
rescue => e
  warn e.message
  raise e
end

something_function

Undine.load registers a post process to catch an unrescued exception and google its message. In this code, NoMethodError raises as String does not have foo method. As executing this code, you are going to see google search page with the error message: https://www.google.com/search?q=undefined+method+%60foo%27+for+%22hoge%22%3AString%0ADid+you+mean%3F++for

Configuration

Undine.configure is for users to customize behavior of Undine. The method gives a given block Undine::Configuration object.

Undine

…

View on GitHub

Installation

gem install undine

Or if your app uses bundler add the following line to Gemfile:

gem 'undine', group: :development

Usage

Undine.load registers a process to be executed at exit.
The process checks existence of exception unrescued in your code and open your browser to google with message of the exception as keyword.

Here is sample code:

require 'undine'

Undine.load

def something_function
  'hoge'.foo
rescue => e
  warn e.message
  raise e
end

something_function

In this code, something_function raises NoMethodError and the exception is not rescued.
The process registered by Undine.load catches it and generates a query from the exception object, in default, just calls the exception's message.
The query is as follows:

https://www.google.com/search?q=undefined+method+%60foo%27+for+%22hoge%22%3AString%0ADid+you+mean%3F++for

Welcome Bug reports, feature requests and pull-requests!

I'm going to welcome any issue and pull-request 👍
Please open new issue or pull-request at the repo.