https://github.com/namchee/dupliket
Triage issues and discussions efficiently by resolving duplicate references with LLM ðŸ§
https://github.com/namchee/dupliket
action llm
Last synced: 3 months ago
JSON representation
Triage issues and discussions efficiently by resolving duplicate references with LLM ðŸ§
- Host: GitHub
- URL: https://github.com/namchee/dupliket
- Owner: Namchee
- License: mit
- Created: 2023-06-27T02:49:30.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T14:34:42.000Z (almost 3 years ago)
- Last Synced: 2025-01-30T03:28:01.560Z (over 1 year ago)
- Topics: action, llm
- Language: TypeScript
- Homepage:
- Size: 7.08 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dupliket
Dupliket is a GitHub action that helps repository maintainers to triage issues and discussions efficiently by finding duplicates and reference them directly in the newly created issue or discussion. It is powered by LLM provided by [OpenAI](https://openai.com/) to process issues and calculate their similarites.
## Installation
You can integrate Dupliket in your GitHub workflow by creating a new [workflow file](https://docs.github.com/en/actions/using-workflows/about-workflows), for example:
```yaml
on:
issues:
types: [opened]
jobs:
dupliket:
runs-on: ubuntu-latest
steps:
- name: Find possible duplicates
uses: Namchee/dupliket@
with:
access_token: ${{ secrets.GITHUB_TOKEN }}
api_key: ${{ secrets.API_KEY }}
```
## Supported Events
Dupliket supports the following workflow events:
| Event | Types | Description |
| ----- | ------ | ----------- |
| `issues` | `created` | Fired whenever a new issue is created. |
| `discussion` | `opened` | Fired whenever a new discussion is created. |
Please refer to the [workflow events reference][workflow] for more information about the supported events.
> Since GitHub includes pull request on `issues` events, it is recommended to filter pull request events when listening to `issues` events.
> You can filter pull request using [job conditions][] in your workflow file. For example:
> ```yaml
> on:
> issues:
> types: [opened]
>
> jobs:
> dupliket:
> runs-on: ubuntu-latest
> if: ${{ !github.event.issue.pull_request }} # Do not listen to pull request events
> steps:
> - name: Find possible duplicates
> uses: Namchee/dupliket@
> with:
> access_token: ${{ secrets.GITHUB_TOKEN }}
> api_key: ${{ secrets.API_KEY }}
>```
## Inputs
Dupliket accepts the following input that can be filled in [`jobs.with`][job input] section:
| **Name** | **Required?** | **Default Value** | **Description** |
| -------- | ------------- | ----------------- | --------------- |
| `access_token` | `true` | *This field is required* | [GitHub's access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). Used to interact with GitHub API for managing knowledge and creating comments. **Note: Ensure that your token have permissions to read and write code and issues**
| `api_key` | `true` | *This field is required* | OpenAI's API key. You can get it by [signing up][] for an OpenAI account |
| `model` | `false` | `text-embedding-ada-002` | Language model to be used when searching and calculating issue and discussion similarity. |
| `max_issues` | `false` | `3` | Maximum number of possibly similar issues and discussions to be displayed |
| `min_similarity` | `false` | `0.9` | Minimum similarity for an issue or discussion to be considered as similar. Must be a floating point between `0.0` and `1.0` |
| `show_similarity` | `false` | `false` | Include similarity percentage as [footnote](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#footnotes) |
| `discussions` | `false` | `true` | Include [discussions](https://github.com/features/discussions) when searching for similar references |
| `label` | `false` | | Label to be applied when an issue or discussion has duplicates. Fill with an empty string to not apply any labels |
| `template` | `false` | | Apply a custom message when an issue or discussion has duplicates. See section [customizing message](#customizing-message) for more detailed information on how to use this field.
### Customizing Message
By default, `dupliket` will create a message containing references existing issues and discussions when an issue or discussion is created and has potential duplicates. While this is good enough for normal use-cases, you might want to change the message to suit your needs or want to change the formatting instead.
You can customize the message by providing a [mustache template](https://github.com/janl/mustache.js) to `template` option in the workflow file. Markdown formatting is supported.
Below are the list of replacable values that you can use in your custom message:
| **Name** | **Description** |
| -------- | ------------- |
| `user` | Username that triggers the event |
| `count` | Number of similar issues and discussions |
| `references` | List of issue and discussion links |
For example, given the below template:
```
Hi {{ user }},
Thanks for reporting an issue! However, it seems like there are {{ count }} issue(s) that are similar to yours:
{{ references }}
```
the action may reply with the following comment
```
Hi @Namchee,
Thanks for reporting an issue! However, it seems like there are 3 issue(s) that are similar to yours:
- https://github.com/Namchee/dupliket/issues/49
- https://github.com/Namchee/dupliket/issues/48
```
## License
This project is licensed under the [MIT License](./LICENSE)
[job input]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idwith
[job conditions]: https://docs.github.com/en/actions/using-jobs/using-conditions-to-control-job-execution
[signing up]: https://platform.openai.com/signup
[workflow]: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows