https://github.com/actions-cool/issues-similarity-analysis

👁 A GitHub Action help you analysis similarity based on the title of issue.
https://github.com/actions-cool/issues-similarity-analysis

analytics github-actions issues similarity

Last synced: about 1 year ago
JSON representation

👁 A GitHub Action help you analysis similarity based on the title of issue.

• Host: GitHub
• URL: https://github.com/actions-cool/issues-similarity-analysis
• Owner: actions-cool
• License: mit
• Created: 2021-03-21T05:36:20.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-18T05:45:01.000Z (over 2 years ago)
• Last Synced: 2025-05-06T06:07:40.452Z (about 1 year ago)
• Topics: analytics, github-actions, issues, similarity
• Language: JavaScript
• Homepage:
• Size: 422 KB
• Stars: 21
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 👁 Issues Similarity Analysis

![](https://img.shields.io/github/actions/workflow/status/actions-cool/issues-similarity-analysis/test.yml?branch=main&style=flat-square)

[![](https://img.shields.io/badge/marketplace-issues--similarity--analysis-blueviolet?style=flat-square)](https://github.com/marketplace/actions/issues-similarity-analysis)

[![](https://img.shields.io/github/v/release/actions-cool/issues-similarity-analysis?style=flat-square&color=orange)](https://github.com/actions-cool/issues-similarity-analysis/releases)

A GitHub Action help you analysis similarity based on the title of issue.

## 👋 Preview

- https://github.com/actions-cool/test-issues-helper/issues/70

## 🚀 How to use?

```yml

name: Issues Similarity Analysis

on:

  issues:

    types: [opened, edited]

jobs:

  similarity-analysis:

    runs-on: ubuntu-latest

    steps:

      - name: analysis

        uses: actions-cool/issues-similarity-analysis@v1

        with:

          filter-threshold: 0.5

          title-excludes: 'bug, not, 1234'

          comment-title: '### See'

          comment-body: '${index}. ${similarity} #${number}'

```

| Name | Desc | Type | Default | Required |

| -- | -- | -- | -- | -- |

| token | GitHub token. | string | GitHub Bot Token | ✖ |

| since-days | How days to query the issues that updated since. | number | 100 | ✖ |

| filter-threshold | Filter issues similarity higher than this threshold. | number | 0.8 | ✖ |

| title-excludes | Exclude words before filter. | string | - | ✖ |

| comment-title | Comment title customization. | string | `### Issues Similarity Analysis:` | ✖ |

| comment-body | Comment body customization. | string | `- [#${number}][${title}][${similarity}]` | ✖ |

| show-footer | Whether show footer. | boolean | true | ✖ |

| show-mentioned | Whether show mentioned issues in the current issue body | boolean | false | ✖ |

- `filter-threshold`: Keep in `[0, 1]`

- `comment-body`:

  - The filter issues sort by threshold desc

  - Support `${index}` `${number}` `${title}` `${similarity}`

The return format is as follows:

```js

  "similar-issues": [

    { "number": 6, "title": "bug 2", "similarity": 1 },

    { "number": 10, "title": "bug", "similarity": 0.85 },

    { "number": 8, "title": "bug", "similarity": 0.85 }

  ],

  "similar-issues-found": "true",

  "similar-issues-number": "6,10,8"

```

- Return `similar-issues-found`, due to yml reasons, the judgment condition is `if: steps.step-id.outputs.similar-issues-found =='true'`

## ⚡ Feedback

You are very welcome to try it out and put forward your comments. You can use the following methods:

- Report bugs or consult with [Issue](https://github.com/actions-cool/issues-similarity-analysis/issues)

- Submit [Pull Request](https://github.com/actions-cool/issues-similarity-analysis/pulls) to improve the code of `issues-similarity-analysis`

也欢迎加入 钉钉交流群

![](https://github.com/actions-cool/resources/blob/main/dingding.jpeg?raw=true)

## Changelog

[CHANGELOG](./CHANGELOG.md)

## LICENSE

[MIT](./LICENSE)