Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peaceiris/actions-suggest-related-links
A GitHub Action to suggest related or similar issues, documents, and links. Based on the power of NLP and fastText.
https://github.com/peaceiris/actions-suggest-related-links
actions fasttext github-actions issue-management nlp
Last synced: 15 days ago
JSON representation
A GitHub Action to suggest related or similar issues, documents, and links. Based on the power of NLP and fastText.
- Host: GitHub
- URL: https://github.com/peaceiris/actions-suggest-related-links
- Owner: peaceiris
- License: mit
- Created: 2020-09-17T20:58:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T17:29:43.000Z (21 days ago)
- Last Synced: 2024-10-26T11:32:12.167Z (20 days ago)
- Topics: actions, fasttext, github-actions, issue-management, nlp
- Language: TypeScript
- Homepage:
- Size: 1.32 MB
- Stars: 31
- Watchers: 3
- Forks: 2
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## Suggest Related Links Action
A GitHub Action to suggest related or similar issues, documents, and links. Based on the power of NLP and fastText.
Sometimes, users create a new issue that is similar to already opened or closed issues. When you face the issue, you need to find similar issues or related links and post it as a comment. That process is a pain, right? This action can do it instead of you!
[](https://github.com/peaceiris/actions-suggest-related-links/blob/main/LICENSE)
[](https://github.com/peaceiris/actions-suggest-related-links/releases/latest)
[](https://github.com/peaceiris/actions-suggest-related-links/releases)
[](https://github.com/peaceiris/actions-suggest-related-links/releases.atom)
[](https://codecov.io/gh/peaceiris/actions-suggest-related-links)
[](https://www.codefactor.io/repository/github/peaceiris/actions-suggest-related-links)
[](https://codeclimate.com/github/peaceiris/actions-suggest-related-links/maintainability)
## Table of Contents
- [Getting Started](#getting-started)
- [Create Workflow](#create-workflow)
- [Save Issues Data](#save-issues-data)
- [Create Issue](#create-issue)
- [Overview](#overview)
- [Data Collection](#data-collection)
- [Preprocessing](#preprocessing)
- [Train Model](#train-model)
- [Find Similar Issues](#find-similar-issues)
- [Suggest Issues](#suggest-issues)
- [Maintainers](#maintainers)
- [License](#license)
## Getting Started
### Create Workflow
Create your YAML workflow file as follows.
e.g. `.github/workflows/suggest-related-links.yml`
```yaml
name: 'Suggest Related Links'
on:
issues:
types:
- opened
- edited
workflow_dispatch:
schedule:
- cron: '13 13 * * */7'
jobs:
action:
runs-on: ubuntu-18.04
steps:
- name: Cache dependencies
uses: actions/cache@v2
with:
path: ~/actions-suggest-related-links-tmp
key: ${{ runner.os }}-action-${{ hashFiles('~/actions-suggest-related-links-tmp/training-data.json') }}
restore-keys: |
${{ runner.os }}-action-
- uses: peaceiris/[email protected]
- uses: peaceiris/actions-suggest-related-links/models/[email protected]
if: github.event_name == 'issues'
with:
version: v1.1.1
- uses: peaceiris/[email protected]
with:
mode: 'suggest'
repository: 'peaceiris/actions-gh-pages'
unclickable: true
```
### Save Issues Data
Run It manually only the first time to save issues data.
After the first running, it will be automatically executed following the setting of the `schedule.cron`.
### Create Issue
Some related links which are similar to the created issue body will be listed by this action.
## Overview
Our GitHub Action is **actions-suggest-related-links**, which suggests related or similar issues, documents, and links.
This action mainly consists of 5 parts: Data Collection, Preprocessing, Train model, Find similar issues, and Suggest Issues.
### Data Collection
All issues of the repository are collected with the GitHub API.
The issues include the title, body, and comments.
Training Data is regularly collected using the scheduling function and output as an artifact and saved as a cache.
### Preprocessing
The Markdown format is converted to plain text with [unified].
At this time, symbols that are not alphabetic characters are deleted.
- https://github.com/peaceiris/actions-suggest-related-links/blob/main/actions/src/preprocess.ts
[unified]: https://unifiedjs.com/
### Train Model
When a new issue is created or updated, the fastText model is trained.
In accordance with its name, fastText has the advantage of very short inference times.
We think training time at the GitHub Actions runners won't be an issue.
In the case of [GitHub Actions for GitHub Pages] repository, the training execution time is 1 sec and the total execution time is about 30 sec.
[fastText]: https://fasttext.cc/
[GitHub Actions for GitHub Pages]: https://github.com/peaceiris/actions-gh-pages
### Find Similar Issues
Calculate word vectors of training data and word vectors of posted data in fastText.
The cosine similarity is used to determine which word vectors of training data is close to the word vectors of the posted data.
The higher the cosine similarity, the more similar the sentence.
### Suggest Issues
## Maintainers
- [peaceiris (Shohei Ueda)](https://github.com/peaceiris)
- [S-Kaisei (Kaisei Shimura)](https://github.com/S-Kaisei)
## License
- [MIT License | peaceiris/actions-suggest-related-links/LICENSE](https://github.com/peaceiris/actions-suggest-related-links/blob/main/LICENSE)